From 1b30b03fb67b20b3c8de56f0bde360134bd587c5 Mon Sep 17 00:00:00 2001 From: Vincent Giersch Date: Mon, 23 Apr 2018 17:09:21 +0200 Subject: [PATCH] feat(client): Update to API specification v2.6.0 --- CHANGELOG.md | 4 + README.md | 46 +- docs/ClassApi.md | 4 +- docs/Collection.md | 18 + docs/CollectionApi.md | 521 +++++++++++++++ docs/CollectionCapabilities.md | 12 + docs/CollectionCreation.md | 8 + docs/CollectionModification.md | 8 + docs/CollectionPrivacy.md | 7 + docs/CollectionTitle.md | 7 + docs/CollectionType.md | 7 + docs/ResourceCollaborator.md | 16 + ...ion.md => ResourceCollaboratorCreation.md} | 3 +- docs/ResourceRights.md | 10 + docs/ResourceSharingKey.md | 7 + docs/ScoreApi.md | 235 ++++--- docs/ScoreCollaborator.md | 15 - docs/ScoreCreation.md | 3 +- docs/ScoreDetails.md | 4 +- docs/ScoreFork.md | 1 + docs/ScoreModification.md | 3 +- docs/ScoreRights.md | 10 - docs/UserApi.md | 2 +- flat_api.gemspec | 2 +- lib/flat_api.rb | 17 +- lib/flat_api/api/account_api.rb | 2 +- lib/flat_api/api/class_api.rb | 2 +- lib/flat_api/api/collection_api.rb | 596 ++++++++++++++++++ lib/flat_api/api/group_api.rb | 2 +- lib/flat_api/api/organization_api.rb | 2 +- lib/flat_api/api/score_api.rb | 178 ++++-- lib/flat_api/api/user_api.rb | 6 +- lib/flat_api/api_client.rb | 2 +- lib/flat_api/api_error.rb | 2 +- lib/flat_api/configuration.rb | 2 +- lib/flat_api/models/assignment.rb | 2 +- lib/flat_api/models/assignment_copy.rb | 2 +- lib/flat_api/models/assignment_creation.rb | 2 +- lib/flat_api/models/assignment_submission.rb | 2 +- .../models/assignment_submission_update.rb | 2 +- .../models/class_attachment_creation.rb | 2 +- lib/flat_api/models/class_creation.rb | 2 +- lib/flat_api/models/class_details.rb | 2 +- lib/flat_api/models/class_details_canvas.rb | 2 +- lib/flat_api/models/class_details_clever.rb | 2 +- .../models/class_details_google_classroom.rb | 2 +- .../models/class_details_google_drive.rb | 2 +- lib/flat_api/models/class_details_lti.rb | 2 +- lib/flat_api/models/class_roles.rb | 2 +- lib/flat_api/models/class_state.rb | 2 +- lib/flat_api/models/class_update.rb | 2 +- lib/flat_api/models/collection.rb | 285 +++++++++ .../models/collection_capabilities.rb | 229 +++++++ lib/flat_api/models/collection_creation.rb | 193 ++++++ .../models/collection_modification.rb | 188 ++++++ lib/flat_api/models/collection_privacy.rb | 30 + lib/flat_api/models/collection_title.rb | 179 ++++++ lib/flat_api/models/collection_type.rb | 34 + lib/flat_api/models/flat_error_response.rb | 2 +- lib/flat_api/models/flat_locales.rb | 2 +- .../models/google_classroom_coursework.rb | 2 +- .../models/google_classroom_submission.rb | 2 +- lib/flat_api/models/group.rb | 2 +- lib/flat_api/models/group_details.rb | 2 +- lib/flat_api/models/group_type.rb | 2 +- lib/flat_api/models/license_mode.rb | 2 +- lib/flat_api/models/license_sources.rb | 2 +- lib/flat_api/models/lms_name.rb | 2 +- lib/flat_api/models/lti_credentials.rb | 2 +- .../models/lti_credentials_creation.rb | 2 +- lib/flat_api/models/media_attachment.rb | 2 +- .../models/media_score_sharing_mode.rb | 2 +- .../models/organization_invitation.rb | 2 +- .../organization_invitation_creation.rb | 2 +- lib/flat_api/models/organization_roles.rb | 2 +- ...llaborator.rb => resource_collaborator.rb} | 98 +-- ...n.rb => resource_collaborator_creation.rb} | 18 +- .../{score_rights.rb => resource_rights.rb} | 12 +- lib/flat_api/models/resource_sharing_key.rb | 179 ++++++ lib/flat_api/models/score_comment.rb | 2 +- lib/flat_api/models/score_comment_context.rb | 2 +- lib/flat_api/models/score_comment_creation.rb | 2 +- lib/flat_api/models/score_comment_update.rb | 2 +- lib/flat_api/models/score_comments_counts.rb | 2 +- lib/flat_api/models/score_creation.rb | 16 +- lib/flat_api/models/score_creation_type.rb | 2 +- lib/flat_api/models/score_data.rb | 2 +- lib/flat_api/models/score_data_encoding.rb | 2 +- lib/flat_api/models/score_details.rb | 6 +- lib/flat_api/models/score_fork.rb | 16 +- lib/flat_api/models/score_license.rb | 2 +- lib/flat_api/models/score_likes_counts.rb | 2 +- lib/flat_api/models/score_modification.rb | 33 +- lib/flat_api/models/score_privacy.rb | 2 +- lib/flat_api/models/score_revision.rb | 2 +- .../models/score_revision_creation.rb | 2 +- .../models/score_revision_statistics.rb | 2 +- lib/flat_api/models/score_source.rb | 2 +- lib/flat_api/models/score_summary.rb | 2 +- lib/flat_api/models/score_track.rb | 2 +- lib/flat_api/models/score_track_creation.rb | 2 +- lib/flat_api/models/score_track_point.rb | 2 +- lib/flat_api/models/score_track_state.rb | 2 +- lib/flat_api/models/score_track_type.rb | 2 +- lib/flat_api/models/score_track_update.rb | 2 +- lib/flat_api/models/score_views_counts.rb | 2 +- lib/flat_api/models/user_admin_update.rb | 2 +- lib/flat_api/models/user_basics.rb | 2 +- lib/flat_api/models/user_creation.rb | 2 +- lib/flat_api/models/user_details.rb | 2 +- lib/flat_api/models/user_details_admin.rb | 2 +- .../models/user_details_admin_license.rb | 2 +- lib/flat_api/models/user_instruments.rb | 2 +- lib/flat_api/models/user_public.rb | 2 +- lib/flat_api/models/user_public_summary.rb | 2 +- lib/flat_api/version.rb | 4 +- spec/api/account_api_spec.rb | 4 +- spec/api/class_api_spec.rb | 4 +- spec/api/collection_api_spec.rb | 159 +++++ spec/api/group_api_spec.rb | 4 +- spec/api/organization_api_spec.rb | 4 +- spec/api/score_api_spec.rb | 67 +- spec/api/user_api_spec.rb | 6 +- spec/api_client_spec.rb | 4 +- spec/configuration_spec.rb | 4 +- spec/models/assignment_copy_spec.rb | 4 +- spec/models/assignment_creation_spec.rb | 4 +- spec/models/assignment_spec.rb | 4 +- spec/models/assignment_submission_spec.rb | 4 +- .../assignment_submission_update_spec.rb | 4 +- spec/models/class_attachment_creation_spec.rb | 4 +- spec/models/class_creation_spec.rb | 4 +- spec/models/class_details_canvas_spec.rb | 4 +- spec/models/class_details_clever_spec.rb | 4 +- .../class_details_google_classroom_spec.rb | 4 +- .../models/class_details_google_drive_spec.rb | 4 +- spec/models/class_details_lti_spec.rb | 4 +- spec/models/class_details_spec.rb | 4 +- spec/models/class_roles_spec.rb | 4 +- spec/models/class_state_spec.rb | 4 +- spec/models/class_update_spec.rb | 4 +- spec/models/collection_capabilities_spec.rb | 66 ++ spec/models/collection_creation_spec.rb | 42 ++ spec/models/collection_modification_spec.rb | 42 ++ spec/models/collection_privacy_spec.rb | 36 ++ spec/models/collection_spec.rb | 102 +++ spec/models/collection_title_spec.rb | 36 ++ spec/models/collection_type_spec.rb | 36 ++ spec/models/flat_error_response_spec.rb | 4 +- spec/models/flat_locales_spec.rb | 4 +- .../google_classroom_coursework_spec.rb | 4 +- .../google_classroom_submission_spec.rb | 4 +- spec/models/group_details_spec.rb | 4 +- spec/models/group_spec.rb | 4 +- spec/models/group_type_spec.rb | 4 +- spec/models/license_mode_spec.rb | 4 +- spec/models/license_sources_spec.rb | 4 +- spec/models/lms_name_spec.rb | 4 +- spec/models/lti_credentials_creation_spec.rb | 4 +- spec/models/lti_credentials_spec.rb | 4 +- spec/models/media_attachment_spec.rb | 4 +- spec/models/media_score_sharing_mode_spec.rb | 4 +- .../organization_invitation_creation_spec.rb | 4 +- spec/models/organization_invitation_spec.rb | 4 +- spec/models/organization_roles_spec.rb | 4 +- ...=> resource_collaborator_creation_spec.rb} | 22 +- ..._spec.rb => resource_collaborator_spec.rb} | 38 +- ...rights_spec.rb => resource_rights_spec.rb} | 22 +- spec/models/resource_sharing_key_spec.rb | 36 ++ spec/models/score_comment_context_spec.rb | 4 +- spec/models/score_comment_creation_spec.rb | 4 +- spec/models/score_comment_spec.rb | 4 +- spec/models/score_comment_update_spec.rb | 4 +- spec/models/score_comments_counts_spec.rb | 4 +- spec/models/score_creation_spec.rb | 10 +- spec/models/score_creation_type_spec.rb | 4 +- spec/models/score_data_encoding_spec.rb | 4 +- spec/models/score_data_spec.rb | 4 +- spec/models/score_details_spec.rb | 4 +- spec/models/score_fork_spec.rb | 10 +- spec/models/score_license_spec.rb | 4 +- spec/models/score_likes_counts_spec.rb | 4 +- spec/models/score_modification_spec.rb | 10 +- spec/models/score_privacy_spec.rb | 4 +- spec/models/score_revision_creation_spec.rb | 4 +- spec/models/score_revision_spec.rb | 4 +- spec/models/score_revision_statistics_spec.rb | 4 +- spec/models/score_source_spec.rb | 4 +- spec/models/score_summary_spec.rb | 4 +- spec/models/score_track_creation_spec.rb | 4 +- spec/models/score_track_point_spec.rb | 4 +- spec/models/score_track_spec.rb | 4 +- spec/models/score_track_state_spec.rb | 4 +- spec/models/score_track_type_spec.rb | 4 +- spec/models/score_track_update_spec.rb | 4 +- spec/models/score_views_counts_spec.rb | 4 +- spec/models/user_admin_update_spec.rb | 4 +- spec/models/user_basics_spec.rb | 4 +- spec/models/user_creation_spec.rb | 4 +- .../models/user_details_admin_license_spec.rb | 4 +- spec/models/user_details_admin_spec.rb | 4 +- spec/models/user_details_spec.rb | 4 +- spec/models/user_instruments_spec.rb | 4 +- spec/models/user_public_spec.rb | 4 +- spec/models/user_public_summary_spec.rb | 4 +- spec/spec_helper.rb | 4 +- 206 files changed, 3879 insertions(+), 567 deletions(-) create mode 100644 docs/Collection.md create mode 100644 docs/CollectionApi.md create mode 100644 docs/CollectionCapabilities.md create mode 100644 docs/CollectionCreation.md create mode 100644 docs/CollectionModification.md create mode 100644 docs/CollectionPrivacy.md create mode 100644 docs/CollectionTitle.md create mode 100644 docs/CollectionType.md create mode 100644 docs/ResourceCollaborator.md rename docs/{ScoreCollaboratorCreation.md => ResourceCollaboratorCreation.md} (86%) create mode 100644 docs/ResourceRights.md create mode 100644 docs/ResourceSharingKey.md delete mode 100644 docs/ScoreCollaborator.md delete mode 100644 docs/ScoreRights.md create mode 100644 lib/flat_api/api/collection_api.rb create mode 100644 lib/flat_api/models/collection.rb create mode 100644 lib/flat_api/models/collection_capabilities.rb create mode 100644 lib/flat_api/models/collection_creation.rb create mode 100644 lib/flat_api/models/collection_modification.rb create mode 100644 lib/flat_api/models/collection_privacy.rb create mode 100644 lib/flat_api/models/collection_title.rb create mode 100644 lib/flat_api/models/collection_type.rb rename lib/flat_api/models/{score_collaborator.rb => resource_collaborator.rb} (84%) rename lib/flat_api/models/{score_collaborator_creation.rb => resource_collaborator_creation.rb} (94%) rename lib/flat_api/models/{score_rights.rb => resource_rights.rb} (92%) create mode 100644 lib/flat_api/models/resource_sharing_key.rb create mode 100644 spec/api/collection_api_spec.rb create mode 100644 spec/models/collection_capabilities_spec.rb create mode 100644 spec/models/collection_creation_spec.rb create mode 100644 spec/models/collection_modification_spec.rb create mode 100644 spec/models/collection_privacy_spec.rb create mode 100644 spec/models/collection_spec.rb create mode 100644 spec/models/collection_title_spec.rb create mode 100644 spec/models/collection_type_spec.rb rename spec/models/{score_collaborator_creation_spec.rb => resource_collaborator_creation_spec.rb} (83%) rename spec/models/{score_collaborator_spec.rb => resource_collaborator_spec.rb} (85%) rename spec/models/{score_rights_spec.rb => resource_rights_spec.rb} (81%) create mode 100644 spec/models/resource_sharing_key_spec.rb diff --git a/CHANGELOG.md b/CHANGELOG.md index 0982954..f9b7059 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## 0.2.0 + +Spec version 2.6.0 + ## 0.1.2 Spec version 2.5.2 diff --git a/README.md b/README.md index c952c12..f8bb2e9 100644 --- a/README.md +++ b/README.md @@ -27,15 +27,15 @@ gem build flat_api.gemspec Then either install the gem locally: ```shell -gem install ./flat_api-0.1.2.gem +gem install ./flat_api-0.2.0.gem ``` -(for development, run `gem install --dev ./flat_api-0.1.2.gem` to install the development dependencies) +(for development, run `gem install --dev ./flat_api-0.2.0.gem` to install the development dependencies) or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/). Finally add this to the Gemfile: - gem 'flat_api', '~> 0.1.2' + gem 'flat_api', '~> 0.2.0' ### Install from Git @@ -102,6 +102,15 @@ Class | Method | HTTP request | Description *FlatApi::ClassApi* | [**list_classes**](docs/ClassApi.md#list_classes) | **GET** /classes | List the classes available for the current user *FlatApi::ClassApi* | [**unarchive_class**](docs/ClassApi.md#unarchive_class) | **DELETE** /classes/{class}/archive | Unarchive the class *FlatApi::ClassApi* | [**update_class**](docs/ClassApi.md#update_class) | **PUT** /classes/{class} | Update the class +*FlatApi::CollectionApi* | [**add_score_to_collection**](docs/CollectionApi.md#add_score_to_collection) | **PUT** /collections/{collection}/scores/{score} | Add a score to the collection +*FlatApi::CollectionApi* | [**create_collection**](docs/CollectionApi.md#create_collection) | **POST** /collections | Create a new collection +*FlatApi::CollectionApi* | [**delete_collection**](docs/CollectionApi.md#delete_collection) | **DELETE** /collections/{collection} | Delete the collection +*FlatApi::CollectionApi* | [**delete_score_from_collection**](docs/CollectionApi.md#delete_score_from_collection) | **DELETE** /collections/{collection}/scores/{score} | Delete a score from the collection +*FlatApi::CollectionApi* | [**edit_collection**](docs/CollectionApi.md#edit_collection) | **PUT** /collections/{collection} | Update a collection's metadata +*FlatApi::CollectionApi* | [**get_collection**](docs/CollectionApi.md#get_collection) | **GET** /collections/{collection} | Get collection details +*FlatApi::CollectionApi* | [**list_collection_scores**](docs/CollectionApi.md#list_collection_scores) | **GET** /collections/{collection}/scores | List the scores contained in a collection +*FlatApi::CollectionApi* | [**list_collections**](docs/CollectionApi.md#list_collections) | **GET** /collections | List the collections +*FlatApi::CollectionApi* | [**untrash_collection**](docs/CollectionApi.md#untrash_collection) | **POST** /collections/{collection}/untrash | Untrash a collection *FlatApi::GroupApi* | [**get_group_details**](docs/GroupApi.md#get_group_details) | **GET** /groups/{group} | Get group information *FlatApi::GroupApi* | [**get_group_scores**](docs/GroupApi.md#get_group_scores) | **GET** /groups/{group}/scores | List group's scores *FlatApi::GroupApi* | [**list_group_users**](docs/GroupApi.md#list_group_users) | **GET** /groups/{group}/users | List group's users @@ -141,6 +150,7 @@ Class | Method | HTTP request | Description *FlatApi::ScoreApi* | [**mark_score_comment_unresolved**](docs/ScoreApi.md#mark_score_comment_unresolved) | **DELETE** /scores/{score}/comments/{comment}/resolved | Mark the comment as unresolved *FlatApi::ScoreApi* | [**post_score_comment**](docs/ScoreApi.md#post_score_comment) | **POST** /scores/{score}/comments | Post a new comment *FlatApi::ScoreApi* | [**remove_score_collaborator**](docs/ScoreApi.md#remove_score_collaborator) | **DELETE** /scores/{score}/collaborators/{collaborator} | Delete a collaborator +*FlatApi::ScoreApi* | [**untrash_score**](docs/ScoreApi.md#untrash_score) | **POST** /scores/{score}/untrash | Untrash a score *FlatApi::ScoreApi* | [**update_score_comment**](docs/ScoreApi.md#update_score_comment) | **PUT** /scores/{score}/comments/{comment} | Update an existing comment *FlatApi::ScoreApi* | [**update_score_track**](docs/ScoreApi.md#update_score_track) | **PUT** /scores/{score}/tracks/{track} | Update an audio or video track linked to a score *FlatApi::UserApi* | [**ger_user_likes**](docs/UserApi.md#ger_user_likes) | **GET** /users/{user}/likes | List liked scores @@ -166,6 +176,13 @@ Class | Method | HTTP request | Description - [FlatApi::ClassRoles](docs/ClassRoles.md) - [FlatApi::ClassState](docs/ClassState.md) - [FlatApi::ClassUpdate](docs/ClassUpdate.md) + - [FlatApi::Collection](docs/Collection.md) + - [FlatApi::CollectionCapabilities](docs/CollectionCapabilities.md) + - [FlatApi::CollectionCreation](docs/CollectionCreation.md) + - [FlatApi::CollectionModification](docs/CollectionModification.md) + - [FlatApi::CollectionPrivacy](docs/CollectionPrivacy.md) + - [FlatApi::CollectionTitle](docs/CollectionTitle.md) + - [FlatApi::CollectionType](docs/CollectionType.md) - [FlatApi::FlatErrorResponse](docs/FlatErrorResponse.md) - [FlatApi::FlatLocales](docs/FlatLocales.md) - [FlatApi::GoogleClassroomCoursework](docs/GoogleClassroomCoursework.md) @@ -183,8 +200,9 @@ Class | Method | HTTP request | Description - [FlatApi::OrganizationInvitation](docs/OrganizationInvitation.md) - [FlatApi::OrganizationInvitationCreation](docs/OrganizationInvitationCreation.md) - [FlatApi::OrganizationRoles](docs/OrganizationRoles.md) - - [FlatApi::ScoreCollaborator](docs/ScoreCollaborator.md) - - [FlatApi::ScoreCollaboratorCreation](docs/ScoreCollaboratorCreation.md) + - [FlatApi::ResourceCollaboratorCreation](docs/ResourceCollaboratorCreation.md) + - [FlatApi::ResourceRights](docs/ResourceRights.md) + - [FlatApi::ResourceSharingKey](docs/ResourceSharingKey.md) - [FlatApi::ScoreComment](docs/ScoreComment.md) - [FlatApi::ScoreCommentContext](docs/ScoreCommentContext.md) - [FlatApi::ScoreCommentCreation](docs/ScoreCommentCreation.md) @@ -202,7 +220,6 @@ Class | Method | HTTP request | Description - [FlatApi::ScoreRevision](docs/ScoreRevision.md) - [FlatApi::ScoreRevisionCreation](docs/ScoreRevisionCreation.md) - [FlatApi::ScoreRevisionStatistics](docs/ScoreRevisionStatistics.md) - - [FlatApi::ScoreRights](docs/ScoreRights.md) - [FlatApi::ScoreSource](docs/ScoreSource.md) - [FlatApi::ScoreSummary](docs/ScoreSummary.md) - [FlatApi::ScoreTrack](docs/ScoreTrack.md) @@ -217,6 +234,7 @@ Class | Method | HTTP request | Description - [FlatApi::UserCreation](docs/UserCreation.md) - [FlatApi::UserDetailsAdminLicense](docs/UserDetailsAdminLicense.md) - [FlatApi::UserInstruments](docs/UserInstruments.md) + - [FlatApi::ResourceCollaborator](docs/ResourceCollaborator.md) - [FlatApi::ScoreDetails](docs/ScoreDetails.md) - [FlatApi::UserPublicSummary](docs/UserPublicSummary.md) - [FlatApi::UserDetailsAdmin](docs/UserDetailsAdmin.md) @@ -232,12 +250,15 @@ Class | Method | HTTP request | Description - **Type**: OAuth - **Flow**: accessCode - **Authorization URL**: https://flat.io/auth/oauth -- **Scopes**: - - account.public_profile: Provides access to the basic person's public profile. Education profiles may be anonymized with this scope, you can request the scope `education_profile` to access to the a basic education account profile. - - account.education_profile: Provides access to the basic person's education profile and public organization information. - - scores.readonly: Allows read-only access to all a user's scores. You won't need this scope to read public scores. - - scores.social: Allow to post comments and like scores - - scores: Full, permissive scope to access all of a user's scores. +- **Scopes**: + - account.public_profile: Provides access to the basic person's public profile. Education profiles may be anonymized with this scope, you can request the scope `education_profile` to access to the a basic education account profile. + - account.education_profile: Provides access to the basic person's education profile and public organization information. + - scores.readonly: Allows read-only access to all a user's scores. You won't need this scope to read public scores. + - scores.social: Allow to post comments and like scores + - scores: Full, permissive scope to access all of a user's scores. + - collections.readonly: Allow read-only access to a user's collections. + - collections.add_scores: Allow to add scores to a user's collections. + - collections: Full, permissive scope to access all of a user's collections. - edu.classes: Full, permissive scope to manage the classes. - edu.classes.readonly: Read-only access to the classes. - edu.assignments: Read-write access to the assignments and submissions. @@ -247,3 +268,4 @@ Class | Method | HTTP request | Description - edu.admin.lti.readonly: Read-only access to the LTI Credentials of an organization. - edu.admin.users: Access and manage the users and invitations of the organization. - edu.admin.users.readonly: Read-only access to the users and invitations of the organization. + diff --git a/docs/ClassApi.md b/docs/ClassApi.md index e48ed77..5d89743 100644 --- a/docs/ClassApi.md +++ b/docs/ClassApi.md @@ -625,7 +625,7 @@ Name | Type | Description | Notes # **get_score_submissions** -> Array<AssignmentSubmission> get_score_submissions(score, ) +> Array<AssignmentSubmission> get_score_submissions(score) List submissions related to the score @@ -648,7 +648,7 @@ score = "score_example" # String | Unique identifier of the score document. This begin #List submissions related to the score - result = api_instance.get_score_submissions(score, ) + result = api_instance.get_score_submissions(score) p result rescue FlatApi::ApiError => e puts "Exception when calling ClassApi->get_score_submissions: #{e}" diff --git a/docs/Collection.md b/docs/Collection.md new file mode 100644 index 0000000..6389e54 --- /dev/null +++ b/docs/Collection.md @@ -0,0 +1,18 @@ +# FlatApi::Collection + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | Unique identifier of the collection | [optional] +**title** | [**CollectionTitle**](CollectionTitle.md) | | [optional] +**html_url** | **String** | The url where the collection can be viewed in a web browser | [optional] +**type** | [**CollectionType**](CollectionType.md) | | [optional] +**privacy** | [**CollectionPrivacy**](CollectionPrivacy.md) | | [optional] +**sharing_key** | **String** | The private sharing key of the collection (available when the `privacy` mode is set to `privateLink`) | [optional] +**app** | **String** | If this directory is dedicated to an app, the unique idenfier of this app | [optional] +**user** | [**UserPublicSummary**](UserPublicSummary.md) | | [optional] +**rights** | [**ResourceRights**](ResourceRights.md) | | [optional] +**collaborators** | [**Array<ResourceCollaborator>**](ResourceCollaborator.md) | The list of the collaborators of the collection | [optional] +**capabilities** | [**CollectionCapabilities**](CollectionCapabilities.md) | | [optional] + + diff --git a/docs/CollectionApi.md b/docs/CollectionApi.md new file mode 100644 index 0000000..91c20c5 --- /dev/null +++ b/docs/CollectionApi.md @@ -0,0 +1,521 @@ +# FlatApi::CollectionApi + +All URIs are relative to *https://api.flat.io/v2* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_score_to_collection**](CollectionApi.md#add_score_to_collection) | **PUT** /collections/{collection}/scores/{score} | Add a score to the collection +[**create_collection**](CollectionApi.md#create_collection) | **POST** /collections | Create a new collection +[**delete_collection**](CollectionApi.md#delete_collection) | **DELETE** /collections/{collection} | Delete the collection +[**delete_score_from_collection**](CollectionApi.md#delete_score_from_collection) | **DELETE** /collections/{collection}/scores/{score} | Delete a score from the collection +[**edit_collection**](CollectionApi.md#edit_collection) | **PUT** /collections/{collection} | Update a collection's metadata +[**get_collection**](CollectionApi.md#get_collection) | **GET** /collections/{collection} | Get collection details +[**list_collection_scores**](CollectionApi.md#list_collection_scores) | **GET** /collections/{collection}/scores | List the scores contained in a collection +[**list_collections**](CollectionApi.md#list_collections) | **GET** /collections | List the collections +[**untrash_collection**](CollectionApi.md#untrash_collection) | **POST** /collections/{collection}/untrash | Untrash a collection + + +# **add_score_to_collection** +> ScoreDetails add_score_to_collection(collection, score, opts) + +Add a score to the collection + +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. + +### Example +```ruby +# load the gem +require 'flat_api' +# setup authorization +FlatApi.configure do |config| + # Configure OAuth2 access token for authorization: OAuth2 + config.access_token = 'YOUR ACCESS TOKEN' +end + +api_instance = FlatApi::CollectionApi.new + +collection = "collection_example" # String | 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 + +score = "score_example" # 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`). + +opts = { + sharing_key: "sharing_key_example" # String | 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. +} + +begin + #Add a score to the collection + result = api_instance.add_score_to_collection(collection, score, opts) + p result +rescue FlatApi::ApiError => e + puts "Exception when calling CollectionApi->add_score_to_collection: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **collection** | **String**| 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 | + **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`). | + **sharing_key** | **String**| 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. | [optional] + +### Return type + +[**ScoreDetails**](ScoreDetails.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **create_collection** +> Collection create_collection(body) + +Create a new collection + +This method will create a new collection and add it to your `root` collection. + +### Example +```ruby +# load the gem +require 'flat_api' +# setup authorization +FlatApi.configure do |config| + # Configure OAuth2 access token for authorization: OAuth2 + config.access_token = 'YOUR ACCESS TOKEN' +end + +api_instance = FlatApi::CollectionApi.new + +body = FlatApi::CollectionCreation.new # CollectionCreation | + + +begin + #Create a new collection + result = api_instance.create_collection(body) + p result +rescue FlatApi::ApiError => e + puts "Exception when calling CollectionApi->create_collection: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CollectionCreation**](CollectionCreation.md)| | + +### Return type + +[**Collection**](Collection.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **delete_collection** +> delete_collection(collection, ) + +Delete the collection + +This method will schedule the deletion of the collection. Until deleted, the collection will be available in the `trash`. + +### Example +```ruby +# load the gem +require 'flat_api' +# setup authorization +FlatApi.configure do |config| + # Configure OAuth2 access token for authorization: OAuth2 + config.access_token = 'YOUR ACCESS TOKEN' +end + +api_instance = FlatApi::CollectionApi.new + +collection = "collection_example" # String | 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 + + +begin + #Delete the collection + api_instance.delete_collection(collection, ) +rescue FlatApi::ApiError => e + puts "Exception when calling CollectionApi->delete_collection: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **collection** | **String**| 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 | + +### Return type + +nil (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **delete_score_from_collection** +> delete_score_from_collection(collection, score) + +Delete a score from the collection + +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. + +### Example +```ruby +# load the gem +require 'flat_api' +# setup authorization +FlatApi.configure do |config| + # Configure OAuth2 access token for authorization: OAuth2 + config.access_token = 'YOUR ACCESS TOKEN' +end + +api_instance = FlatApi::CollectionApi.new + +collection = "collection_example" # String | 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 + +score = "score_example" # 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`). + + +begin + #Delete a score from the collection + api_instance.delete_score_from_collection(collection, score) +rescue FlatApi::ApiError => e + puts "Exception when calling CollectionApi->delete_score_from_collection: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **collection** | **String**| 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 | + **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`). | + +### Return type + +nil (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **edit_collection** +> Collection edit_collection(collection, , opts) + +Update a collection's metadata + +### Example +```ruby +# load the gem +require 'flat_api' +# setup authorization +FlatApi.configure do |config| + # Configure OAuth2 access token for authorization: OAuth2 + config.access_token = 'YOUR ACCESS TOKEN' +end + +api_instance = FlatApi::CollectionApi.new + +collection = "collection_example" # String | 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 + +opts = { + body: FlatApi::CollectionModification.new # CollectionModification | +} + +begin + #Update a collection's metadata + result = api_instance.edit_collection(collection, , opts) + p result +rescue FlatApi::ApiError => e + puts "Exception when calling CollectionApi->edit_collection: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **collection** | **String**| 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 | + **body** | [**CollectionModification**](CollectionModification.md)| | [optional] + +### Return type + +[**Collection**](Collection.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **get_collection** +> Collection get_collection(collection, , opts) + +Get collection details + +### Example +```ruby +# load the gem +require 'flat_api' +# setup authorization +FlatApi.configure do |config| + # Configure OAuth2 access token for authorization: OAuth2 + config.access_token = 'YOUR ACCESS TOKEN' +end + +api_instance = FlatApi::CollectionApi.new + +collection = "collection_example" # String | 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 + +opts = { + sharing_key: "sharing_key_example" # String | 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. +} + +begin + #Get collection details + result = api_instance.get_collection(collection, , opts) + p result +rescue FlatApi::ApiError => e + puts "Exception when calling CollectionApi->get_collection: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **collection** | **String**| 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 | + **sharing_key** | **String**| 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. | [optional] + +### Return type + +[**Collection**](Collection.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **list_collection_scores** +> Array<ScoreDetails> list_collection_scores(collection, , opts) + +List the scores contained in a collection + +Use this method to list the scores contained in a collection. If no sort option is provided, the scores are sorted by `modificationDate` `desc`. + +### Example +```ruby +# load the gem +require 'flat_api' +# setup authorization +FlatApi.configure do |config| + # Configure OAuth2 access token for authorization: OAuth2 + config.access_token = 'YOUR ACCESS TOKEN' +end + +api_instance = FlatApi::CollectionApi.new + +collection = "collection_example" # String | 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 + +opts = { + sharing_key: "sharing_key_example" # String | 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. + sort: "sort_example", # String | Sort + direction: "direction_example", # String | Sort direction + limit: 25, # Integer | This is the maximum number of objects that may be returned + _next: "_next_example", # String | 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. + previous: "previous_example" # String | 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. +} + +begin + #List the scores contained in a collection + result = api_instance.list_collection_scores(collection, , opts) + p result +rescue FlatApi::ApiError => e + puts "Exception when calling CollectionApi->list_collection_scores: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **collection** | **String**| 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 | + **sharing_key** | **String**| 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. | [optional] + **sort** | **String**| Sort | [optional] + **direction** | **String**| Sort direction | [optional] + **limit** | **Integer**| This is the maximum number of objects that may be returned | [optional] [default to 25] + **_next** | **String**| 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. | [optional] + **previous** | **String**| 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. | [optional] + +### Return type + +[**Array<ScoreDetails>**](ScoreDetails.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **list_collections** +> Array<Collection> list_collections(opts) + +List the collections + +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`. + +### Example +```ruby +# load the gem +require 'flat_api' +# setup authorization +FlatApi.configure do |config| + # Configure OAuth2 access token for authorization: OAuth2 + config.access_token = 'YOUR ACCESS TOKEN' +end + +api_instance = FlatApi::CollectionApi.new + +opts = { + parent: "root", # String | 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`. + sort: "sort_example", # String | Sort + direction: "direction_example", # String | Sort direction + limit: 25, # Integer | This is the maximum number of objects that may be returned + _next: "_next_example", # String | 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. + previous: "previous_example" # String | 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. +} + +begin + #List the collections + result = api_instance.list_collections(opts) + p result +rescue FlatApi::ApiError => e + puts "Exception when calling CollectionApi->list_collections: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **parent** | **String**| 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`. | [optional] [default to root] + **sort** | **String**| Sort | [optional] + **direction** | **String**| Sort direction | [optional] + **limit** | **Integer**| This is the maximum number of objects that may be returned | [optional] [default to 25] + **_next** | **String**| 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. | [optional] + **previous** | **String**| 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. | [optional] + +### Return type + +[**Array<Collection>**](Collection.md) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +# **untrash_collection** +> untrash_collection(collection, ) + +Untrash a collection + +This method will restore the collection by removing it from the `trash` and add it back to the `root` collection. + +### Example +```ruby +# load the gem +require 'flat_api' +# setup authorization +FlatApi.configure do |config| + # Configure OAuth2 access token for authorization: OAuth2 + config.access_token = 'YOUR ACCESS TOKEN' +end + +api_instance = FlatApi::CollectionApi.new + +collection = "collection_example" # String | 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 + + +begin + #Untrash a collection + api_instance.untrash_collection(collection, ) +rescue FlatApi::ApiError => e + puts "Exception when calling CollectionApi->untrash_collection: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **collection** | **String**| 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 | + +### Return type + +nil (empty response body) + +### Authorization + +[OAuth2](../README.md#OAuth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + diff --git a/docs/CollectionCapabilities.md b/docs/CollectionCapabilities.md new file mode 100644 index 0000000..be59da9 --- /dev/null +++ b/docs/CollectionCapabilities.md @@ -0,0 +1,12 @@ +# FlatApi::CollectionCapabilities + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**can_edit** | **BOOLEAN** | Whether the current user can modify the metadata for the collection | [optional] +**can_share** | **BOOLEAN** | Whether the current user can modify the sharing settings for the collection | [optional] +**can_delete** | **BOOLEAN** | Whether the current user can delete the collection | [optional] +**can_add_scores** | **BOOLEAN** | Whether the current user can add scores to the collection If this collection has the `type` `trash`, this property will be set to `false`. Use `DELETE /v2/scores/{score}` to trash a score. | [optional] +**can_delete_scores** | **BOOLEAN** | Whether the current user can delete scores from the collection If this collection has the `type` `trash`, this property will be set to `false`. Use `POST /v2/scores/{score}/untrash` to restore a score. | [optional] + + diff --git a/docs/CollectionCreation.md b/docs/CollectionCreation.md new file mode 100644 index 0000000..b4aa33a --- /dev/null +++ b/docs/CollectionCreation.md @@ -0,0 +1,8 @@ +# FlatApi::CollectionCreation + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | [**CollectionTitle**](CollectionTitle.md) | | + + diff --git a/docs/CollectionModification.md b/docs/CollectionModification.md new file mode 100644 index 0000000..f2ad608 --- /dev/null +++ b/docs/CollectionModification.md @@ -0,0 +1,8 @@ +# FlatApi::CollectionModification + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | [**CollectionTitle**](CollectionTitle.md) | | [optional] + + diff --git a/docs/CollectionPrivacy.md b/docs/CollectionPrivacy.md new file mode 100644 index 0000000..061cb53 --- /dev/null +++ b/docs/CollectionPrivacy.md @@ -0,0 +1,7 @@ +# FlatApi::CollectionPrivacy + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/CollectionTitle.md b/docs/CollectionTitle.md new file mode 100644 index 0000000..1679b10 --- /dev/null +++ b/docs/CollectionTitle.md @@ -0,0 +1,7 @@ +# FlatApi::CollectionTitle + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/CollectionType.md b/docs/CollectionType.md new file mode 100644 index 0000000..1694cfc --- /dev/null +++ b/docs/CollectionType.md @@ -0,0 +1,7 @@ +# FlatApi::CollectionType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/ResourceCollaborator.md b/docs/ResourceCollaborator.md new file mode 100644 index 0000000..155e66a --- /dev/null +++ b/docs/ResourceCollaborator.md @@ -0,0 +1,16 @@ +# FlatApi::ResourceCollaborator + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**acl_read** | **BOOLEAN** | `True` if the current user can read the current document | [optional] [default to false] +**acl_write** | **BOOLEAN** | `True` if the current user can modify the current document. If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection. | [optional] [default to false] +**acl_admin** | **BOOLEAN** | `True` if the current user can manage the current document (i.e. share, delete) If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection. | [optional] [default to false] +**id** | **String** | The unique identifier of the permission | [optional] +**score** | **String** | If this object is a permission of a score, this property will contain the unique identifier of the score | [optional] +**collection** | **String** | If this object is a permission of a collection, this property will contain the unique identifier of the collection | [optional] +**user** | [**UserPublic**](UserPublic.md) | | [optional] +**group** | [**Group**](Group.md) | | [optional] +**user_email** | **String** | If the collaborator is not a user of Flat yet, this field will contain his email. | [optional] + + diff --git a/docs/ScoreCollaboratorCreation.md b/docs/ResourceCollaboratorCreation.md similarity index 86% rename from docs/ScoreCollaboratorCreation.md rename to docs/ResourceCollaboratorCreation.md index 56d92b8..41f82fc 100644 --- a/docs/ScoreCollaboratorCreation.md +++ b/docs/ResourceCollaboratorCreation.md @@ -1,4 +1,4 @@ -# FlatApi::ScoreCollaboratorCreation +# FlatApi::ResourceCollaboratorCreation ## Properties Name | Type | Description | Notes @@ -6,6 +6,7 @@ Name | Type | Description | Notes **user** | **String** | The unique identifier of a Flat user | [optional] **group** | **String** | The unique identifier of a Flat group | [optional] **user_email** | **String** | Fill this field to invite an individual user by email. | [optional] +**user_token** | **String** | Token received in an invitation to join the score. | [optional] **acl_read** | **BOOLEAN** | `True` if the related user can read the score. (probably true if the user has a permission on the document). | [optional] [default to true] **acl_write** | **BOOLEAN** | `True` if the related user can modify the score. | [optional] [default to false] **acl_admin** | **BOOLEAN** | `True` if the related user can can manage the current document, i.e. changing the document permissions and deleting the document | [optional] [default to false] diff --git a/docs/ResourceRights.md b/docs/ResourceRights.md new file mode 100644 index 0000000..1992843 --- /dev/null +++ b/docs/ResourceRights.md @@ -0,0 +1,10 @@ +# FlatApi::ResourceRights + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**acl_read** | **BOOLEAN** | `True` if the current user can read the current document | [optional] [default to false] +**acl_write** | **BOOLEAN** | `True` if the current user can modify the current document. If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection. | [optional] [default to false] +**acl_admin** | **BOOLEAN** | `True` if the current user can manage the current document (i.e. share, delete) If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection. | [optional] [default to false] + + diff --git a/docs/ResourceSharingKey.md b/docs/ResourceSharingKey.md new file mode 100644 index 0000000..b85b741 --- /dev/null +++ b/docs/ResourceSharingKey.md @@ -0,0 +1,7 @@ +# FlatApi::ResourceSharingKey + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/ScoreApi.md b/docs/ScoreApi.md index 5bf7fc7..94f1b1a 100644 --- a/docs/ScoreApi.md +++ b/docs/ScoreApi.md @@ -30,16 +30,17 @@ Method | HTTP request | Description [**mark_score_comment_unresolved**](ScoreApi.md#mark_score_comment_unresolved) | **DELETE** /scores/{score}/comments/{comment}/resolved | Mark the comment as unresolved [**post_score_comment**](ScoreApi.md#post_score_comment) | **POST** /scores/{score}/comments | Post a new comment [**remove_score_collaborator**](ScoreApi.md#remove_score_collaborator) | **DELETE** /scores/{score}/collaborators/{collaborator} | Delete a collaborator +[**untrash_score**](ScoreApi.md#untrash_score) | **POST** /scores/{score}/untrash | Untrash a score [**update_score_comment**](ScoreApi.md#update_score_comment) | **PUT** /scores/{score}/comments/{comment} | Update an existing comment [**update_score_track**](ScoreApi.md#update_score_track) | **PUT** /scores/{score}/tracks/{track} | Update an audio or video track linked to a score # **add_score_collaborator** -> ScoreCollaborator add_score_collaborator(score, body) +> ResourceCollaborator add_score_collaborator(scorebody) Add a new collaborator -Share a score with a single user or a group. This API call allows to add, invite and update the collaborators of a document. - To add an existing Flat user to the document, specify its unique identifier in the `user` property. - To invite an external user to the document, specify its email in the `userEmail` property. - To add a Flat group to the document, specify its unique identifier in the `group` property. - To update an existing collaborator, process the same request with different rights. +Share a score with a single user or a group. This API call allows to add, invite and update the collaborators of a resource. - To add an existing Flat user to the resource, specify its unique identifier in the `user` property. - To invite an external user to the resource, specify its email in the `userEmail` property. - To add a Flat group to the resource, specify its unique identifier in the `group` property. - To update an existing collaborator, process the same request with different rights. ### Example ```ruby @@ -55,12 +56,12 @@ api_instance = FlatApi::ScoreApi.new score = "score_example" # 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`). -body = FlatApi::ScoreCollaboratorCreation.new # ScoreCollaboratorCreation | +body = FlatApi::ResourceCollaboratorCreation.new # ResourceCollaboratorCreation | begin #Add a new collaborator - result = api_instance.add_score_collaborator(score, body) + result = api_instance.add_score_collaborator(scorebody) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->add_score_collaborator: #{e}" @@ -72,11 +73,11 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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`). | - **body** | [**ScoreCollaboratorCreation**](ScoreCollaboratorCreation.md)| | + **body** | [**ResourceCollaboratorCreation**](ResourceCollaboratorCreation.md)| | ### Return type -[**ScoreCollaborator**](ScoreCollaborator.md) +[**ResourceCollaborator**](ResourceCollaborator.md) ### Authorization @@ -90,7 +91,7 @@ Name | Type | Description | Notes # **add_score_track** -> ScoreTrack add_score_track(score, body) +> ScoreTrack add_score_track(scorebody) Add a new video or audio track to the score @@ -115,7 +116,7 @@ body = FlatApi::ScoreTrackCreation.new # ScoreTrackCreation | begin #Add a new video or audio track to the score - result = api_instance.add_score_track(score, body) + result = api_instance.add_score_track(scorebody) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->add_score_track: #{e}" @@ -149,7 +150,7 @@ Name | Type | Description | Notes Create a new score -Use this API method to **create a new music score in the current User account**. You will need a MusicXML 3 (`vnd.recordare.musicxml` or `vnd.recordare.musicxml+xml`) or a MIDI (`audio/midi`) file to create the new Flat document. This API call will automatically create the first revision of the document, the score can be modified by the using our web application or by uploading a new revision of this file (`POST /v2/scores/{score}/revisions/{revision}`). The currently authenticated user will be granted owner of the file and will be able to add other collaborators (users and groups). +Use this API method to **create a new music score in the current User account**. You will need a MusicXML 3 (`vnd.recordare.musicxml` or `vnd.recordare.musicxml+xml`) or a MIDI (`audio/midi`) file to create the new Flat document. This API call will automatically create the first revision of the document, the score can be modified by the using our web application or by uploading a new revision of this file (`POST /v2/scores/{score}/revisions/{revision}`). The currently authenticated user will be granted owner of the file and will be able to add other collaborators (users and groups). If no `collection` is specified, the API will create the score in the most appropriate collection. This can be the `root` collection or a different collection based on the user's settings or API authentication method. If a `collection` is specified and this one has more public privacy settings than the score (e.g. `public` vs `private` for the score), the privacy settings of the created score will be adjusted to the collection ones. You can check the adjusted privacy settings in the returned score `privacy`, and optionally adjust these settings if needed using `PUT /scores/{score}`. ### Example ```ruby @@ -197,7 +198,7 @@ Name | Type | Description | Notes # **create_score_revision** -> ScoreRevision create_score_revision(score, body) +> ScoreRevision create_score_revision(scorebody) Create a new revision @@ -222,7 +223,7 @@ body = FlatApi::ScoreRevisionCreation.new # ScoreRevisionCreation | begin #Create a new revision - result = api_instance.create_score_revision(score, body) + result = api_instance.create_score_revision(scorebody) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->create_score_revision: #{e}" @@ -252,11 +253,11 @@ Name | Type | Description | Notes # **delete_score** -> delete_score(score, ) +> delete_score(score) Delete a score -This API call will schedule the deletion of the score, its revisions, and whole history. The user calling this API method must have the `aclAdmin` rights on this document to process this action. The score won't be accessible anymore after calling this method and the user's quota will directly be updated. +This method can be used by the owner/admin (`aclAdmin` rights) of a score as well as regular collaborators. When called by an owner/admin, it will schedule the deletion of the score, its revisions, and complete history. The score won't be accessible anymore after calling this method and the user's quota will directly be updated. When called by a regular collaborator (`aclRead` / `aclWrite`), the score will be unshared (i.e. removed from the account & own collections). ### Example ```ruby @@ -275,7 +276,7 @@ score = "score_example" # String | Unique identifier of the score document. This begin #Delete a score - api_instance.delete_score(score, ) + api_instance.delete_score(score) rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->delete_score: #{e}" end @@ -303,7 +304,7 @@ nil (empty response body) # **delete_score_comment** -> delete_score_comment(score, comment, opts) +> delete_score_comment(scorecomment, opts) Delete a comment @@ -324,12 +325,12 @@ score = "score_example" # String | Unique identifier of the score document. This comment = "comment_example" # String | Unique identifier of a sheet music comment opts = { - sharing_key: "sharing_key_example", # String | This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + sharing_key: "sharing_key_example" # String | 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. } begin #Delete a comment - api_instance.delete_score_comment(score, comment, opts) + api_instance.delete_score_comment(scorecomment, opts) rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->delete_score_comment: #{e}" end @@ -341,7 +342,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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`). | **comment** | **String**| Unique identifier of a sheet music comment | - **sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] + **sharing_key** | **String**| 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. | [optional] ### Return type @@ -359,7 +360,7 @@ nil (empty response body) # **delete_score_track** -> delete_score_track(score, track) +> delete_score_track(scoretrack) Remove an audio or video track linked to the score @@ -382,7 +383,7 @@ track = "track_example" # String | Unique identifier of a score audio track begin #Remove an audio or video track linked to the score - api_instance.delete_score_track(score, track) + api_instance.delete_score_track(scoretrack) rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->delete_score_track: #{e}" end @@ -411,11 +412,11 @@ nil (empty response body) # **edit_score** -> ScoreDetails edit_score(score, , opts) +> ScoreDetails edit_score(score, opts) Edit a score's metadata -This API method allows you to change the metadata of a score document (e.g. its `title` or `privacy`), all the properties are optional. To edit the file itself, create a new revision using the appropriate method (`POST /v2/scores/{score}/revisions/{revision}`). +This API method allows you to change the metadata of a score document (e.g. its `title` or `privacy`), all the properties are optional. To edit the file itself, create a new revision using the appropriate method (`POST /v2/scores/{score}/revisions/{revision}`). When editing the `title` of the score, the API metadata are updated directly when calling this method, unlike the data itself. The title in the score data will be \"lazy\" updated at the next score save with the editor or our internal save. ### Example ```ruby @@ -437,7 +438,7 @@ opts = { begin #Edit a score's metadata - result = api_instance.edit_score(score, , opts) + result = api_instance.edit_score(score, opts) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->edit_score: #{e}" @@ -467,7 +468,7 @@ Name | Type | Description | Notes # **fork_score** -> ScoreDetails fork_score(score, body, opts) +> ScoreDetails fork_score(scorebody, opts) Fork a score @@ -490,12 +491,12 @@ score = "score_example" # String | Unique identifier of the score document. This body = FlatApi::ScoreFork.new # ScoreFork | opts = { - sharing_key: "sharing_key_example", # String | This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + sharing_key: "sharing_key_example" # String | 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. } begin #Fork a score - result = api_instance.fork_score(score, body, opts) + result = api_instance.fork_score(scorebody, opts) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->fork_score: #{e}" @@ -508,7 +509,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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`). | **body** | [**ScoreFork**](ScoreFork.md)| | - **sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] + **sharing_key** | **String**| 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. | [optional] ### Return type @@ -636,7 +637,7 @@ Name | Type | Description | Notes # **get_score** -> ScoreDetails get_score(score, , opts) +> ScoreDetails get_score(score, opts) Get a score's metadata @@ -657,12 +658,12 @@ api_instance = FlatApi::ScoreApi.new score = "score_example" # 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`). opts = { - sharing_key: "sharing_key_example", # String | This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + sharing_key: "sharing_key_example" # String | 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. } begin #Get a score's metadata - result = api_instance.get_score(score, , opts) + result = api_instance.get_score(score, opts) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->get_score: #{e}" @@ -674,7 +675,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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`). | - **sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] + **sharing_key** | **String**| 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. | [optional] ### Return type @@ -692,7 +693,7 @@ Name | Type | Description | Notes # **get_score_collaborator** -> ScoreCollaborator get_score_collaborator(score, collaborator, opts) +> ResourceCollaborator get_score_collaborator(scorecollaborator, opts) Get a collaborator @@ -715,12 +716,12 @@ score = "score_example" # String | Unique identifier of the score document. This collaborator = "collaborator_example" # String | Unique identifier of a **collaborator permission**, or unique identifier of a **User**, or unique identifier of a **Group** opts = { - sharing_key: "sharing_key_example", # String | This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + sharing_key: "sharing_key_example" # String | 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. } begin #Get a collaborator - result = api_instance.get_score_collaborator(score, collaborator, opts) + result = api_instance.get_score_collaborator(scorecollaborator, opts) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->get_score_collaborator: #{e}" @@ -733,11 +734,11 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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`). | **collaborator** | **String**| Unique identifier of a **collaborator permission**, or unique identifier of a **User**, or unique identifier of a **Group** | - **sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] + **sharing_key** | **String**| 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. | [optional] ### Return type -[**ScoreCollaborator**](ScoreCollaborator.md) +[**ResourceCollaborator**](ResourceCollaborator.md) ### Authorization @@ -751,7 +752,7 @@ Name | Type | Description | Notes # **get_score_collaborators** -> Array<ScoreCollaborator> get_score_collaborators(score, , opts) +> Array<ResourceCollaborator> get_score_collaborators(score, opts) List the collaborators @@ -772,12 +773,12 @@ api_instance = FlatApi::ScoreApi.new score = "score_example" # 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`). opts = { - sharing_key: "sharing_key_example", # String | This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + sharing_key: "sharing_key_example" # String | 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. } begin #List the collaborators - result = api_instance.get_score_collaborators(score, , opts) + result = api_instance.get_score_collaborators(score, opts) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->get_score_collaborators: #{e}" @@ -789,11 +790,11 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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`). | - **sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] + **sharing_key** | **String**| 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. | [optional] ### Return type -[**Array<ScoreCollaborator>**](ScoreCollaborator.md) +[**Array<ResourceCollaborator>**](ResourceCollaborator.md) ### Authorization @@ -807,7 +808,7 @@ Name | Type | Description | Notes # **get_score_comments** -> Array<ScoreComment> get_score_comments(score, , opts) +> Array<ScoreComment> get_score_comments(score, opts) List comments @@ -828,12 +829,15 @@ api_instance = FlatApi::ScoreApi.new score = "score_example" # 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`). opts = { - sharing_key: "sharing_key_example", # String | This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + sharing_key: "sharing_key_example" # String | 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. + type: "type_example", # String | Filter the comments by type + sort: "sort_example", # String | Sort + direction: "direction_example", # String | Sort direction } begin #List comments - result = api_instance.get_score_comments(score, , opts) + result = api_instance.get_score_comments(score, opts) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->get_score_comments: #{e}" @@ -845,7 +849,10 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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`). | - **sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] + **sharing_key** | **String**| 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. | [optional] + **type** | **String**| Filter the comments by type | [optional] + **sort** | **String**| Sort | [optional] + **direction** | **String**| Sort direction | [optional] ### Return type @@ -863,7 +870,7 @@ Name | Type | Description | Notes # **get_score_revision** -> ScoreRevision get_score_revision(score, revision, , opts) +> ScoreRevision get_score_revision(scorerevision, , opts) Get a score revision @@ -886,12 +893,12 @@ score = "score_example" # String | Unique identifier of the score document. This revision = "revision_example" # String | Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. opts = { - sharing_key: "sharing_key_example", # String | This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + sharing_key: "sharing_key_example" # String | 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. } begin #Get a score revision - result = api_instance.get_score_revision(score, revision, , opts) + result = api_instance.get_score_revision(scorerevision, , opts) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->get_score_revision: #{e}" @@ -904,7 +911,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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`). | **revision** | **String**| Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. | - **sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] + **sharing_key** | **String**| 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. | [optional] ### Return type @@ -922,7 +929,7 @@ Name | Type | Description | Notes # **get_score_revision_data** -> String get_score_revision_data(score, revision, format, opts) +> String get_score_revision_data(scorerevision, format, opts) Get a score revision data @@ -947,14 +954,14 @@ revision = "revision_example" # String | Unique identifier of a score revision. format = "format_example" # String | The format of the file you will retrieve opts = { - sharing_key: "sharing_key_example", # String | This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. - only_cached: true, # BOOLEAN | Only return files already generated and cached in Flat's production cache. If the file is not availabe, a 404 will be returned - parts: "parts_example" # String | An optional a set of parts to be exported. This parameter must be specified with a list of integers. For example \"1,2,5\". + sharing_key: "sharing_key_example" # String | 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. + parts: "parts_example", # String | An optional a set of parts to be exported. This parameter must be specified with a list of integers. For example \"1,2,5\". + only_cached: true # BOOLEAN | Only return files already generated and cached in Flat's production cache. If the file is not availabe, a 404 will be returned } begin #Get a score revision data - result = api_instance.get_score_revision_data(score, revision, format, opts) + result = api_instance.get_score_revision_data(scorerevision, format, opts) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->get_score_revision_data: #{e}" @@ -968,9 +975,9 @@ Name | Type | Description | Notes **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`). | **revision** | **String**| Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. | **format** | **String**| The format of the file you will retrieve | - **sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] - **only_cached** | **BOOLEAN**| Only return files already generated and cached in Flat's production cache. If the file is not availabe, a 404 will be returned | [optional] + **sharing_key** | **String**| 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. | [optional] **parts** | **String**| An optional a set of parts to be exported. This parameter must be specified with a list of integers. For example \"1,2,5\". | [optional] + **only_cached** | **BOOLEAN**| Only return files already generated and cached in Flat's production cache. If the file is not availabe, a 404 will be returned | [optional] ### Return type @@ -988,7 +995,7 @@ Name | Type | Description | Notes # **get_score_revisions** -> Array<ScoreRevision> get_score_revisions(score, , opts) +> Array<ScoreRevision> get_score_revisions(score, opts) List the revisions @@ -1009,12 +1016,12 @@ api_instance = FlatApi::ScoreApi.new score = "score_example" # 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`). opts = { - sharing_key: "sharing_key_example", # String | This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + sharing_key: "sharing_key_example" # String | 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. } begin #List the revisions - result = api_instance.get_score_revisions(score, , opts) + result = api_instance.get_score_revisions(score, opts) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->get_score_revisions: #{e}" @@ -1026,7 +1033,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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`). | - **sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] + **sharing_key** | **String**| 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. | [optional] ### Return type @@ -1044,7 +1051,7 @@ Name | Type | Description | Notes # **get_score_submissions** -> Array<AssignmentSubmission> get_score_submissions(score, ) +> Array<AssignmentSubmission> get_score_submissions(score) List submissions related to the score @@ -1067,7 +1074,7 @@ score = "score_example" # String | Unique identifier of the score document. This begin #List submissions related to the score - result = api_instance.get_score_submissions(score, ) + result = api_instance.get_score_submissions(score) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->get_score_submissions: #{e}" @@ -1096,7 +1103,7 @@ Name | Type | Description | Notes # **get_score_track** -> ScoreTrack get_score_track(score, track, opts) +> ScoreTrack get_score_track(scoretrack, opts) Retrieve the details of an audio or video track linked to a score @@ -1117,12 +1124,12 @@ score = "score_example" # String | Unique identifier of the score document. This track = "track_example" # String | Unique identifier of a score audio track opts = { - sharing_key: "sharing_key_example", # String | This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + sharing_key: "sharing_key_example" # String | 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. } begin #Retrieve the details of an audio or video track linked to a score - result = api_instance.get_score_track(score, track, opts) + result = api_instance.get_score_track(scoretrack, opts) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->get_score_track: #{e}" @@ -1135,7 +1142,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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`). | **track** | **String**| Unique identifier of a score audio track | - **sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] + **sharing_key** | **String**| 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. | [optional] ### Return type @@ -1157,7 +1164,7 @@ Name | Type | Description | Notes List user's scores -Get the list of scores owned by the User +Get the list of public scores owned by a User. **DEPRECATED**: Please note that the current behavior will be deprecrated on **2019-01-01**. This method will no longer list private and shared scores, but only public scores of a Flat account. If you want to access to private scores, please use the [Collections API](#tag/Collection) instead. ### Example ```ruby @@ -1209,7 +1216,7 @@ Name | Type | Description | Notes # **list_score_tracks** -> Array<ScoreTrack> list_score_tracks(score, , opts) +> Array<ScoreTrack> list_score_tracks(score, opts) List the audio or video tracks linked to a score @@ -1228,12 +1235,12 @@ api_instance = FlatApi::ScoreApi.new score = "score_example" # 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`). opts = { - sharing_key: "sharing_key_example", # String | This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + sharing_key: "sharing_key_example" # String | 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. } begin #List the audio or video tracks linked to a score - result = api_instance.list_score_tracks(score, , opts) + result = api_instance.list_score_tracks(score, opts) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->list_score_tracks: #{e}" @@ -1245,7 +1252,7 @@ end Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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`). | - **sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] + **sharing_key** | **String**| 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. | [optional] ### Return type @@ -1263,7 +1270,7 @@ Name | Type | Description | Notes # **mark_score_comment_resolved** -> mark_score_comment_resolved(score, comment, opts) +> mark_score_comment_resolved(scorecomment, opts) Mark the comment as resolved @@ -1284,12 +1291,12 @@ score = "score_example" # String | Unique identifier of the score document. This comment = "comment_example" # String | Unique identifier of a sheet music comment opts = { - sharing_key: "sharing_key_example", # String | This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + sharing_key: "sharing_key_example" # String | 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. } begin #Mark the comment as resolved - api_instance.mark_score_comment_resolved(score, comment, opts) + api_instance.mark_score_comment_resolved(scorecomment, opts) rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->mark_score_comment_resolved: #{e}" end @@ -1301,7 +1308,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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`). | **comment** | **String**| Unique identifier of a sheet music comment | - **sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] + **sharing_key** | **String**| 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. | [optional] ### Return type @@ -1319,7 +1326,7 @@ nil (empty response body) # **mark_score_comment_unresolved** -> mark_score_comment_unresolved(score, comment, opts) +> mark_score_comment_unresolved(scorecomment, opts) Mark the comment as unresolved @@ -1340,12 +1347,12 @@ score = "score_example" # String | Unique identifier of the score document. This comment = "comment_example" # String | Unique identifier of a sheet music comment opts = { - sharing_key: "sharing_key_example", # String | This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + sharing_key: "sharing_key_example" # String | 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. } begin #Mark the comment as unresolved - api_instance.mark_score_comment_unresolved(score, comment, opts) + api_instance.mark_score_comment_unresolved(scorecomment, opts) rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->mark_score_comment_unresolved: #{e}" end @@ -1357,7 +1364,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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`). | **comment** | **String**| Unique identifier of a sheet music comment | - **sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] + **sharing_key** | **String**| 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. | [optional] ### Return type @@ -1375,7 +1382,7 @@ nil (empty response body) # **post_score_comment** -> ScoreComment post_score_comment(score, body, opts) +> ScoreComment post_score_comment(scorebody, opts) Post a new comment @@ -1398,12 +1405,12 @@ score = "score_example" # String | Unique identifier of the score document. This body = FlatApi::ScoreCommentCreation.new # ScoreCommentCreation | opts = { - sharing_key: "sharing_key_example", # String | This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + sharing_key: "sharing_key_example" # String | 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. } begin #Post a new comment - result = api_instance.post_score_comment(score, body, opts) + result = api_instance.post_score_comment(scorebody, opts) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->post_score_comment: #{e}" @@ -1416,7 +1423,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **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`). | **body** | [**ScoreCommentCreation**](ScoreCommentCreation.md)| | - **sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] + **sharing_key** | **String**| 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. | [optional] ### Return type @@ -1434,7 +1441,7 @@ Name | Type | Description | Notes # **remove_score_collaborator** -> remove_score_collaborator(score, collaborator) +> remove_score_collaborator(scorecollaborator) Delete a collaborator @@ -1459,7 +1466,7 @@ collaborator = "collaborator_example" # String | Unique identifier of a **collab begin #Delete a collaborator - api_instance.remove_score_collaborator(score, collaborator) + api_instance.remove_score_collaborator(scorecollaborator) rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->remove_score_collaborator: #{e}" end @@ -1487,8 +1494,54 @@ nil (empty response body) +# **untrash_score** +> untrash_score(score) + +Untrash a score + +This method will remove the score from the `trash` collection and from the deletion queue, and add it back to the original collections. + +### Example +```ruby +# load the gem +require 'flat_api' + +api_instance = FlatApi::ScoreApi.new + +score = "score_example" # 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`). + + +begin + #Untrash a score + api_instance.untrash_score(score) +rescue FlatApi::ApiError => e + puts "Exception when calling ScoreApi->untrash_score: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **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`). | + +### Return type + +nil (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + # **update_score_comment** -> ScoreComment update_score_comment(score, commentbody, opts) +> ScoreComment update_score_comment(scorecommentbody, opts) Update an existing comment @@ -1511,12 +1564,12 @@ comment = "comment_example" # String | Unique identifier of a sheet music commen body = FlatApi::ScoreCommentUpdate.new # ScoreCommentUpdate | opts = { - sharing_key: "sharing_key_example", # String | This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + sharing_key: "sharing_key_example" # String | 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. } begin #Update an existing comment - result = api_instance.update_score_comment(score, commentbody, opts) + result = api_instance.update_score_comment(scorecommentbody, opts) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->update_score_comment: #{e}" @@ -1530,7 +1583,7 @@ Name | Type | Description | Notes **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`). | **comment** | **String**| Unique identifier of a sheet music comment | **body** | [**ScoreCommentUpdate**](ScoreCommentUpdate.md)| | - **sharing_key** | **String**| This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. | [optional] + **sharing_key** | **String**| 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. | [optional] ### Return type @@ -1548,7 +1601,7 @@ Name | Type | Description | Notes # **update_score_track** -> ScoreTrack update_score_track(score, trackbody) +> ScoreTrack update_score_track(scoretrackbody) Update an audio or video track linked to a score @@ -1573,7 +1626,7 @@ body = FlatApi::ScoreTrackUpdate.new # ScoreTrackUpdate | begin #Update an audio or video track linked to a score - result = api_instance.update_score_track(score, trackbody) + result = api_instance.update_score_track(scoretrackbody) p result rescue FlatApi::ApiError => e puts "Exception when calling ScoreApi->update_score_track: #{e}" diff --git a/docs/ScoreCollaborator.md b/docs/ScoreCollaborator.md deleted file mode 100644 index bf52009..0000000 --- a/docs/ScoreCollaborator.md +++ /dev/null @@ -1,15 +0,0 @@ -# FlatApi::ScoreCollaborator - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | The unique identifier of the score permission | [optional] -**score** | **String** | The unique identifier of the score | [optional] -**user** | [**UserPublic**](UserPublic.md) | | [optional] -**group** | [**Group**](Group.md) | | [optional] -**user_email** | **String** | If the collaborator is not a user of Flat yet, this field will contain his email. | [optional] -**acl_read** | **BOOLEAN** | `True` if the related user can read the score. (probably true if the user has a permission on the document). | [optional] [default to true] -**acl_write** | **BOOLEAN** | `True` if the related user can modify the score. | [optional] [default to false] -**acl_admin** | **BOOLEAN** | `True` if the related user can can manage the current document, i.e. changing the document permissions and deleting the document | [optional] [default to false] - - diff --git a/docs/ScoreCreation.md b/docs/ScoreCreation.md index 1b6c9ed..fa6169f 100644 --- a/docs/ScoreCreation.md +++ b/docs/ScoreCreation.md @@ -3,11 +3,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**title** | **String** | The title of the new score. If this title is not specified, the API will try to (in this order): - Use the name of the file for files from a specified `source` (e.g. Google Drive) - Use the title contained in the file (e.g. [`movement-title`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-movement-title.htm) or [`credit-words`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-credit-words.htm) for [MusicXML](http://www.musicxml.com/) files). - Set a default title (e.g. \"New Music Score\") If the title is already used, the API will append the creation date after the title. If the title is too long, the API may trim this one. | [optional] +**title** | **String** | The title of the new score. If the title is too long, the API may trim this one. If this title is not specified, the API will try to (in this order): - Use the name of the file for files from a specified `source` (e.g. Google Drive) - Use the title contained in the file (e.g. [`movement-title`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-movement-title.htm) or [`credit-words`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-credit-words.htm) for [MusicXML](http://www.musicxml.com/) files). - Set a default title (e.g. \"New Music Score\") | [optional] **privacy** | [**ScorePrivacy**](ScorePrivacy.md) | | **data** | [**ScoreData**](ScoreData.md) | | [optional] **data_encoding** | [**ScoreDataEncoding**](ScoreDataEncoding.md) | | [optional] **source** | [**ScoreSource**](ScoreSource.md) | | [optional] +**collection** | **String** | Unique identifier of a collection where the score will be created. If no collection identifier is provided, the score will be stored in the `root` directory. | [optional] **google_drive_folder** | **String** | If the user uses Google Drive and this properties is specified, the file will be created in this directory. The currently user creating the file must be granted to write in this directory. | [optional] diff --git a/docs/ScoreDetails.md b/docs/ScoreDetails.md index bac2b76..af42895 100644 --- a/docs/ScoreDetails.md +++ b/docs/ScoreDetails.md @@ -20,8 +20,8 @@ Name | Type | Description | Notes **duration_time** | **Integer** | In seconds, an approximative duration of the score | [optional] **number_measures** | **Integer** | The number of measures in the score | [optional] **main_tempo_qpm** | **Integer** | The main tempo of the score (in QPM) | [optional] -**rights** | [**ScoreRights**](ScoreRights.md) | | [optional] -**collaborators** | [**Array<ScoreCollaborator>**](ScoreCollaborator.md) | The list of the collaborators of the score | [optional] +**rights** | [**ResourceRights**](ResourceRights.md) | | [optional] +**collaborators** | [**Array<ResourceCollaborator>**](ResourceCollaborator.md) | The list of the collaborators of the score | [optional] **creation_date** | **DateTime** | The date when the score was created | [optional] **modification_date** | **DateTime** | The date of the last revision of the score | [optional] **publication_date** | **DateTime** | The date when the score was published on Flat | [optional] diff --git a/docs/ScoreFork.md b/docs/ScoreFork.md index 31efd59..5e81b45 100644 --- a/docs/ScoreFork.md +++ b/docs/ScoreFork.md @@ -3,5 +3,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**collection** | **String** | Unique identifier of a collection where the score will be copied. If no collection identifier is provided, the score will be stored in the `root` directory. | [optional] diff --git a/docs/ScoreModification.md b/docs/ScoreModification.md index c640f41..d32a2c3 100644 --- a/docs/ScoreModification.md +++ b/docs/ScoreModification.md @@ -3,8 +3,9 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**title** | **String** | The title of the score | [optional] **privacy** | [**ScorePrivacy**](ScorePrivacy.md) | | [optional] -**sharing_key** | **String** | When using the `privacy` mode `privateLink`, this property can be used to set a custom sharing key, otherwise a new key will be generated. | [optional] +**sharing_key** | [**ResourceSharingKey**](ResourceSharingKey.md) | | [optional] **description** | **String** | Description of the creation | [optional] **tags** | **Array<String>** | Tags describing the score | [optional] **creation_type** | [**ScoreCreationType**](ScoreCreationType.md) | | [optional] diff --git a/docs/ScoreRights.md b/docs/ScoreRights.md deleted file mode 100644 index 7188793..0000000 --- a/docs/ScoreRights.md +++ /dev/null @@ -1,10 +0,0 @@ -# FlatApi::ScoreRights - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**acl_read** | **BOOLEAN** | `True` if the current user can read the current document | [optional] [default to true] -**acl_write** | **BOOLEAN** | `True` if the current user can modify the current document | [optional] [default to false] -**acl_admin** | **BOOLEAN** | `True` if the current user can manage the current document, i.e. changing the document permissions and deleting the document | [optional] [default to false] - - diff --git a/docs/UserApi.md b/docs/UserApi.md index 2e84714..7059871 100644 --- a/docs/UserApi.md +++ b/docs/UserApi.md @@ -120,7 +120,7 @@ Name | Type | Description | Notes List user's scores -Get the list of scores owned by the User +Get the list of public scores owned by a User. **DEPRECATED**: Please note that the current behavior will be deprecrated on **2019-01-01**. This method will no longer list private and shared scores, but only public scores of a Flat account. If you want to access to private scores, please use the [Collections API](#tag/Collection) instead. ### Example ```ruby diff --git a/flat_api.gemspec b/flat_api.gemspec index baf39a8..f6571b3 100644 --- a/flat_api.gemspec +++ b/flat_api.gemspec @@ -5,7 +5,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api.rb b/lib/flat_api.rb index 37c67ed..1ce40f6 100644 --- a/lib/flat_api.rb +++ b/lib/flat_api.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT @@ -33,6 +33,13 @@ require 'flat_api/models/class_roles' require 'flat_api/models/class_state' require 'flat_api/models/class_update' +require 'flat_api/models/collection' +require 'flat_api/models/collection_capabilities' +require 'flat_api/models/collection_creation' +require 'flat_api/models/collection_modification' +require 'flat_api/models/collection_privacy' +require 'flat_api/models/collection_title' +require 'flat_api/models/collection_type' require 'flat_api/models/flat_error_response' require 'flat_api/models/flat_locales' require 'flat_api/models/google_classroom_coursework' @@ -50,8 +57,9 @@ require 'flat_api/models/organization_invitation' require 'flat_api/models/organization_invitation_creation' require 'flat_api/models/organization_roles' -require 'flat_api/models/score_collaborator' -require 'flat_api/models/score_collaborator_creation' +require 'flat_api/models/resource_collaborator_creation' +require 'flat_api/models/resource_rights' +require 'flat_api/models/resource_sharing_key' require 'flat_api/models/score_comment' require 'flat_api/models/score_comment_context' require 'flat_api/models/score_comment_creation' @@ -69,7 +77,6 @@ require 'flat_api/models/score_revision' require 'flat_api/models/score_revision_creation' require 'flat_api/models/score_revision_statistics' -require 'flat_api/models/score_rights' require 'flat_api/models/score_source' require 'flat_api/models/score_summary' require 'flat_api/models/score_track' @@ -84,6 +91,7 @@ require 'flat_api/models/user_creation' require 'flat_api/models/user_details_admin_license' require 'flat_api/models/user_instruments' +require 'flat_api/models/resource_collaborator' require 'flat_api/models/score_details' require 'flat_api/models/user_public_summary' require 'flat_api/models/user_details_admin' @@ -93,6 +101,7 @@ # APIs require 'flat_api/api/account_api' require 'flat_api/api/class_api' +require 'flat_api/api/collection_api' require 'flat_api/api/group_api' require 'flat_api/api/organization_api' require 'flat_api/api/score_api' diff --git a/lib/flat_api/api/account_api.rb b/lib/flat_api/api/account_api.rb index e482cf9..8ab56ba 100644 --- a/lib/flat_api/api/account_api.rb +++ b/lib/flat_api/api/account_api.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/api/class_api.rb b/lib/flat_api/api/class_api.rb index 7b3f3ff..18e967a 100644 --- a/lib/flat_api/api/class_api.rb +++ b/lib/flat_api/api/class_api.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/api/collection_api.rb b/lib/flat_api/api/collection_api.rb new file mode 100644 index 0000000..daa31e3 --- /dev/null +++ b/lib/flat_api/api/collection_api.rb @@ -0,0 +1,596 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require "uri" + +module FlatApi + class CollectionApi + attr_accessor :api_client + + def initialize(api_client = ApiClient.default) + @api_client = api_client + end + + # Add a score to the collection + # 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. + # @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 + # @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`). + # @param [Hash] opts the optional parameters + # @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. + # @return [ScoreDetails] + def add_score_to_collection(collection, score, opts = {}) + data, _status_code, _headers = add_score_to_collection_with_http_info(collection, score, opts) + return data + end + + # Add a score to the collection + # 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. + # @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 + # @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`). + # @param [Hash] opts the optional parameters + # @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. + # @return [Array<(ScoreDetails, Fixnum, Hash)>] ScoreDetails data, response status code and response headers + def add_score_to_collection_with_http_info(collection, score, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: CollectionApi.add_score_to_collection ..." + end + # verify the required parameter 'collection' is set + if @api_client.config.client_side_validation && collection.nil? + fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.add_score_to_collection" + end + # verify the required parameter 'score' is set + if @api_client.config.client_side_validation && score.nil? + fail ArgumentError, "Missing the required parameter 'score' when calling CollectionApi.add_score_to_collection" + end + # resource path + local_var_path = "/collections/{collection}/scores/{score}".sub('{' + 'collection' + '}', collection.to_s).sub('{' + 'score' + '}', score.to_s) + + # query parameters + query_params = {} + query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil? + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = {} + + # http body (model) + post_body = nil + auth_names = ['OAuth2'] + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => 'ScoreDetails') + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionApi#add_score_to_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Create a new collection + # This method will create a new collection and add it to your `root` collection. + # @param body + # @param [Hash] opts the optional parameters + # @return [Collection] + def create_collection(body, opts = {}) + data, _status_code, _headers = create_collection_with_http_info(body, opts) + return data + end + + # Create a new collection + # This method will create a new collection and add it to your `root` collection. + # @param body + # @param [Hash] opts the optional parameters + # @return [Array<(Collection, Fixnum, Hash)>] Collection data, response status code and response headers + def create_collection_with_http_info(body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: CollectionApi.create_collection ..." + end + # verify the required parameter 'body' is set + if @api_client.config.client_side_validation && body.nil? + fail ArgumentError, "Missing the required parameter 'body' when calling CollectionApi.create_collection" + end + # resource path + local_var_path = "/collections" + + # query parameters + query_params = {} + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = {} + + # http body (model) + post_body = @api_client.object_to_http_body(body) + auth_names = ['OAuth2'] + data, status_code, headers = @api_client.call_api(:POST, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => 'Collection') + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionApi#create_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Delete the collection + # This method will schedule the deletion of the collection. Until deleted, the collection will be available in the `trash`. + # @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 + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_collection(collection, opts = {}) + delete_collection_with_http_info(collection, opts) + return nil + end + + # Delete the collection + # This method will schedule the deletion of the collection. Until deleted, the collection will be available in the `trash`. + # @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 + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers + def delete_collection_with_http_info(collection, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: CollectionApi.delete_collection ..." + end + # verify the required parameter 'collection' is set + if @api_client.config.client_side_validation && collection.nil? + fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.delete_collection" + end + # resource path + local_var_path = "/collections/{collection}".sub('{' + 'collection' + '}', collection.to_s) + + # query parameters + query_params = {} + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = {} + + # http body (model) + post_body = nil + auth_names = ['OAuth2'] + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionApi#delete_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Delete a score from the collection + # 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. + # @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 + # @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`). + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_score_from_collection(collection, score, opts = {}) + delete_score_from_collection_with_http_info(collection, score, opts) + return nil + end + + # Delete a score from the collection + # 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. + # @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 + # @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`). + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers + def delete_score_from_collection_with_http_info(collection, score, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: CollectionApi.delete_score_from_collection ..." + end + # verify the required parameter 'collection' is set + if @api_client.config.client_side_validation && collection.nil? + fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.delete_score_from_collection" + end + # verify the required parameter 'score' is set + if @api_client.config.client_side_validation && score.nil? + fail ArgumentError, "Missing the required parameter 'score' when calling CollectionApi.delete_score_from_collection" + end + # resource path + local_var_path = "/collections/{collection}/scores/{score}".sub('{' + 'collection' + '}', collection.to_s).sub('{' + 'score' + '}', score.to_s) + + # query parameters + query_params = {} + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = {} + + # http body (model) + post_body = nil + auth_names = ['OAuth2'] + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionApi#delete_score_from_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Update a collection's metadata + # + # @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 + # @param [Hash] opts the optional parameters + # @option opts [CollectionModification] :body + # @return [Collection] + def edit_collection(collection, opts = {}) + data, _status_code, _headers = edit_collection_with_http_info(collection, opts) + return data + end + + # Update a collection's metadata + # + # @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 + # @param [Hash] opts the optional parameters + # @option opts [CollectionModification] :body + # @return [Array<(Collection, Fixnum, Hash)>] Collection data, response status code and response headers + def edit_collection_with_http_info(collection, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: CollectionApi.edit_collection ..." + end + # verify the required parameter 'collection' is set + if @api_client.config.client_side_validation && collection.nil? + fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.edit_collection" + end + # resource path + local_var_path = "/collections/{collection}".sub('{' + 'collection' + '}', collection.to_s) + + # query parameters + query_params = {} + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = {} + + # http body (model) + post_body = @api_client.object_to_http_body(opts[:'body']) + auth_names = ['OAuth2'] + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => 'Collection') + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionApi#edit_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get collection details + # + # @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 + # @param [Hash] opts the optional parameters + # @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. + # @return [Collection] + def get_collection(collection, opts = {}) + data, _status_code, _headers = get_collection_with_http_info(collection, opts) + return data + end + + # Get collection details + # + # @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 + # @param [Hash] opts the optional parameters + # @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. + # @return [Array<(Collection, Fixnum, Hash)>] Collection data, response status code and response headers + def get_collection_with_http_info(collection, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: CollectionApi.get_collection ..." + end + # verify the required parameter 'collection' is set + if @api_client.config.client_side_validation && collection.nil? + fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.get_collection" + end + # resource path + local_var_path = "/collections/{collection}".sub('{' + 'collection' + '}', collection.to_s) + + # query parameters + query_params = {} + query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil? + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = {} + + # http body (model) + post_body = nil + auth_names = ['OAuth2'] + data, status_code, headers = @api_client.call_api(:GET, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => 'Collection') + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionApi#get_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # List the scores contained in a collection + # Use this method to list the scores contained in a collection. If no sort option is provided, the scores are sorted by `modificationDate` `desc`. + # @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 + # @param [Hash] opts the optional parameters + # @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. + # @option opts [String] :sort Sort + # @option opts [String] :direction Sort direction + # @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25) + # @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. + # @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. + # @return [Array] + def list_collection_scores(collection, opts = {}) + data, _status_code, _headers = list_collection_scores_with_http_info(collection, opts) + return data + end + + # List the scores contained in a collection + # Use this method to list the scores contained in a collection. If no sort option is provided, the scores are sorted by `modificationDate` `desc`. + # @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 + # @param [Hash] opts the optional parameters + # @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. + # @option opts [String] :sort Sort + # @option opts [String] :direction Sort direction + # @option opts [Integer] :limit This is the maximum number of objects that may be returned + # @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. + # @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. + # @return [Array<(Array, Fixnum, Hash)>] Array data, response status code and response headers + def list_collection_scores_with_http_info(collection, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: CollectionApi.list_collection_scores ..." + end + # verify the required parameter 'collection' is set + if @api_client.config.client_side_validation && collection.nil? + fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.list_collection_scores" + end + if @api_client.config.client_side_validation && opts[:'sort'] && !['creationDate', 'modificationDate', 'title'].include?(opts[:'sort']) + fail ArgumentError, 'invalid value for "sort", must be one of creationDate, modificationDate, title' + end + if @api_client.config.client_side_validation && opts[:'direction'] && !['asc', 'desc'].include?(opts[:'direction']) + fail ArgumentError, 'invalid value for "direction", must be one of asc, desc' + end + if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100 + fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CollectionApi.list_collection_scores, must be smaller than or equal to 100.' + end + + if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1 + fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CollectionApi.list_collection_scores, must be greater than or equal to 1.' + end + + # resource path + local_var_path = "/collections/{collection}/scores".sub('{' + 'collection' + '}', collection.to_s) + + # query parameters + query_params = {} + query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil? + query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? + query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil? + query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? + query_params[:'next'] = opts[:'_next'] if !opts[:'_next'].nil? + query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil? + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = {} + + # http body (model) + post_body = nil + auth_names = ['OAuth2'] + data, status_code, headers = @api_client.call_api(:GET, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => 'Array') + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionApi#list_collection_scores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # List the collections + # 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`. + # @param [Hash] opts the optional parameters + # @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) + # @option opts [String] :sort Sort + # @option opts [String] :direction Sort direction + # @option opts [Integer] :limit This is the maximum number of objects that may be returned (default to 25) + # @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. + # @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. + # @return [Array] + def list_collections(opts = {}) + data, _status_code, _headers = list_collections_with_http_info(opts) + return data + end + + # List the collections + # 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`. + # @param [Hash] opts the optional parameters + # @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`. + # @option opts [String] :sort Sort + # @option opts [String] :direction Sort direction + # @option opts [Integer] :limit This is the maximum number of objects that may be returned + # @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. + # @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. + # @return [Array<(Array, Fixnum, Hash)>] Array data, response status code and response headers + def list_collections_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: CollectionApi.list_collections ..." + end + if @api_client.config.client_side_validation && opts[:'parent'] && !['root', 'sharedWithMe', 'trash'].include?(opts[:'parent']) + fail ArgumentError, 'invalid value for "parent", must be one of root, sharedWithMe, trash' + end + if @api_client.config.client_side_validation && opts[:'sort'] && !['creationDate', 'title'].include?(opts[:'sort']) + fail ArgumentError, 'invalid value for "sort", must be one of creationDate, title' + end + if @api_client.config.client_side_validation && opts[:'direction'] && !['asc', 'desc'].include?(opts[:'direction']) + fail ArgumentError, 'invalid value for "direction", must be one of asc, desc' + end + if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100 + fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CollectionApi.list_collections, must be smaller than or equal to 100.' + end + + if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1 + fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CollectionApi.list_collections, must be greater than or equal to 1.' + end + + # resource path + local_var_path = "/collections" + + # query parameters + query_params = {} + query_params[:'parent'] = opts[:'parent'] if !opts[:'parent'].nil? + query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? + query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil? + query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? + query_params[:'next'] = opts[:'_next'] if !opts[:'_next'].nil? + query_params[:'previous'] = opts[:'previous'] if !opts[:'previous'].nil? + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = {} + + # http body (model) + post_body = nil + auth_names = ['OAuth2'] + data, status_code, headers = @api_client.call_api(:GET, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => 'Array') + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionApi#list_collections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Untrash a collection + # This method will restore the collection by removing it from the `trash` and add it back to the `root` collection. + # @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 + # @param [Hash] opts the optional parameters + # @return [nil] + def untrash_collection(collection, opts = {}) + untrash_collection_with_http_info(collection, opts) + return nil + end + + # Untrash a collection + # This method will restore the collection by removing it from the `trash` and add it back to the `root` collection. + # @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 + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers + def untrash_collection_with_http_info(collection, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: CollectionApi.untrash_collection ..." + end + # verify the required parameter 'collection' is set + if @api_client.config.client_side_validation && collection.nil? + fail ArgumentError, "Missing the required parameter 'collection' when calling CollectionApi.untrash_collection" + end + # resource path + local_var_path = "/collections/{collection}/untrash".sub('{' + 'collection' + '}', collection.to_s) + + # query parameters + query_params = {} + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = {} + + # http body (model) + post_body = nil + auth_names = ['OAuth2'] + data, status_code, headers = @api_client.call_api(:POST, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionApi#untrash_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + end +end diff --git a/lib/flat_api/api/group_api.rb b/lib/flat_api/api/group_api.rb index 651ef68..7f72121 100644 --- a/lib/flat_api/api/group_api.rb +++ b/lib/flat_api/api/group_api.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/api/organization_api.rb b/lib/flat_api/api/organization_api.rb index 14f5388..767b4a5 100644 --- a/lib/flat_api/api/organization_api.rb +++ b/lib/flat_api/api/organization_api.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/api/score_api.rb b/lib/flat_api/api/score_api.rb index a0c0be6..0d0a45d 100644 --- a/lib/flat_api/api/score_api.rb +++ b/lib/flat_api/api/score_api.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT @@ -21,22 +21,22 @@ def initialize(api_client = ApiClient.default) end # Add a new collaborator - # Share a score with a single user or a group. This API call allows to add, invite and update the collaborators of a document. - To add an existing Flat user to the document, specify its unique identifier in the `user` property. - To invite an external user to the document, specify its email in the `userEmail` property. - To add a Flat group to the document, specify its unique identifier in the `group` property. - To update an existing collaborator, process the same request with different rights. + # Share a score with a single user or a group. This API call allows to add, invite and update the collaborators of a resource. - To add an existing Flat user to the resource, specify its unique identifier in the `user` property. - To invite an external user to the resource, specify its email in the `userEmail` property. - To add a Flat group to the resource, specify its unique identifier in the `group` property. - To update an existing collaborator, process the same request with different rights. # @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`). # @param body # @param [Hash] opts the optional parameters - # @return [ScoreCollaborator] + # @return [ResourceCollaborator] def add_score_collaborator(score, body, opts = {}) data, _status_code, _headers = add_score_collaborator_with_http_info(score, body, opts) return data end # Add a new collaborator - # Share a score with a single user or a group. This API call allows to add, invite and update the collaborators of a document. - To add an existing Flat user to the document, specify its unique identifier in the `user` property. - To invite an external user to the document, specify its email in the `userEmail` property. - To add a Flat group to the document, specify its unique identifier in the `group` property. - To update an existing collaborator, process the same request with different rights. + # Share a score with a single user or a group. This API call allows to add, invite and update the collaborators of a resource. - To add an existing Flat user to the resource, specify its unique identifier in the `user` property. - To invite an external user to the resource, specify its email in the `userEmail` property. - To add a Flat group to the resource, specify its unique identifier in the `group` property. - To update an existing collaborator, process the same request with different rights. # @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`). # @param body # @param [Hash] opts the optional parameters - # @return [Array<(ScoreCollaborator, Fixnum, Hash)>] ScoreCollaborator data, response status code and response headers + # @return [Array<(ResourceCollaborator, Fixnum, Hash)>] ResourceCollaborator data, response status code and response headers def add_score_collaborator_with_http_info(score, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ScoreApi.add_score_collaborator ..." @@ -74,7 +74,7 @@ def add_score_collaborator_with_http_info(score, body, opts = {}) :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'ScoreCollaborator') + :return_type => 'ResourceCollaborator') if @api_client.config.debugging @api_client.config.logger.debug "API called: ScoreApi#add_score_collaborator\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end @@ -143,7 +143,7 @@ def add_score_track_with_http_info(score, body, opts = {}) end # Create a new score - # Use this API method to **create a new music score in the current User account**. You will need a MusicXML 3 (`vnd.recordare.musicxml` or `vnd.recordare.musicxml+xml`) or a MIDI (`audio/midi`) file to create the new Flat document. This API call will automatically create the first revision of the document, the score can be modified by the using our web application or by uploading a new revision of this file (`POST /v2/scores/{score}/revisions/{revision}`). The currently authenticated user will be granted owner of the file and will be able to add other collaborators (users and groups). + # Use this API method to **create a new music score in the current User account**. You will need a MusicXML 3 (`vnd.recordare.musicxml` or `vnd.recordare.musicxml+xml`) or a MIDI (`audio/midi`) file to create the new Flat document. This API call will automatically create the first revision of the document, the score can be modified by the using our web application or by uploading a new revision of this file (`POST /v2/scores/{score}/revisions/{revision}`). The currently authenticated user will be granted owner of the file and will be able to add other collaborators (users and groups). If no `collection` is specified, the API will create the score in the most appropriate collection. This can be the `root` collection or a different collection based on the user's settings or API authentication method. If a `collection` is specified and this one has more public privacy settings than the score (e.g. `public` vs `private` for the score), the privacy settings of the created score will be adjusted to the collection ones. You can check the adjusted privacy settings in the returned score `privacy`, and optionally adjust these settings if needed using `PUT /scores/{score}`. # @param body # @param [Hash] opts the optional parameters # @return [ScoreDetails] @@ -153,7 +153,7 @@ def create_score(body, opts = {}) end # Create a new score - # Use this API method to **create a new music score in the current User account**. You will need a MusicXML 3 (`vnd.recordare.musicxml` or `vnd.recordare.musicxml+xml`) or a MIDI (`audio/midi`) file to create the new Flat document. This API call will automatically create the first revision of the document, the score can be modified by the using our web application or by uploading a new revision of this file (`POST /v2/scores/{score}/revisions/{revision}`). The currently authenticated user will be granted owner of the file and will be able to add other collaborators (users and groups). + # Use this API method to **create a new music score in the current User account**. You will need a MusicXML 3 (`vnd.recordare.musicxml` or `vnd.recordare.musicxml+xml`) or a MIDI (`audio/midi`) file to create the new Flat document. This API call will automatically create the first revision of the document, the score can be modified by the using our web application or by uploading a new revision of this file (`POST /v2/scores/{score}/revisions/{revision}`). The currently authenticated user will be granted owner of the file and will be able to add other collaborators (users and groups). If no `collection` is specified, the API will create the score in the most appropriate collection. This can be the `root` collection or a different collection based on the user's settings or API authentication method. If a `collection` is specified and this one has more public privacy settings than the score (e.g. `public` vs `private` for the score), the privacy settings of the created score will be adjusted to the collection ones. You can check the adjusted privacy settings in the returned score `privacy`, and optionally adjust these settings if needed using `PUT /scores/{score}`. # @param body # @param [Hash] opts the optional parameters # @return [Array<(ScoreDetails, Fixnum, Hash)>] ScoreDetails data, response status code and response headers @@ -259,7 +259,7 @@ def create_score_revision_with_http_info(score, body, opts = {}) end # Delete a score - # This API call will schedule the deletion of the score, its revisions, and whole history. The user calling this API method must have the `aclAdmin` rights on this document to process this action. The score won't be accessible anymore after calling this method and the user's quota will directly be updated. + # This method can be used by the owner/admin (`aclAdmin` rights) of a score as well as regular collaborators. When called by an owner/admin, it will schedule the deletion of the score, its revisions, and complete history. The score won't be accessible anymore after calling this method and the user's quota will directly be updated. When called by a regular collaborator (`aclRead` / `aclWrite`), the score will be unshared (i.e. removed from the account & own collections). # @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`). # @param [Hash] opts the optional parameters # @return [nil] @@ -269,7 +269,7 @@ def delete_score(score, opts = {}) end # Delete a score - # This API call will schedule the deletion of the score, its revisions, and whole history. The user calling this API method must have the `aclAdmin` rights on this document to process this action. The score won't be accessible anymore after calling this method and the user's quota will directly be updated. + # This method can be used by the owner/admin (`aclAdmin` rights) of a score as well as regular collaborators. When called by an owner/admin, it will schedule the deletion of the score, its revisions, and complete history. The score won't be accessible anymore after calling this method and the user's quota will directly be updated. When called by a regular collaborator (`aclRead` / `aclWrite`), the score will be unshared (i.e. removed from the account & own collections). # @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`). # @param [Hash] opts the optional parameters # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers @@ -317,7 +317,7 @@ def delete_score_with_http_info(score, opts = {}) # @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`). # @param comment Unique identifier of a sheet music comment # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [nil] def delete_score_comment(score, comment, opts = {}) delete_score_comment_with_http_info(score, comment, opts) @@ -329,7 +329,7 @@ def delete_score_comment(score, comment, opts = {}) # @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`). # @param comment Unique identifier of a sheet music comment # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers def delete_score_comment_with_http_info(score, comment, opts = {}) if @api_client.config.debugging @@ -436,7 +436,7 @@ def delete_score_track_with_http_info(score, track, opts = {}) end # Edit a score's metadata - # This API method allows you to change the metadata of a score document (e.g. its `title` or `privacy`), all the properties are optional. To edit the file itself, create a new revision using the appropriate method (`POST /v2/scores/{score}/revisions/{revision}`). + # This API method allows you to change the metadata of a score document (e.g. its `title` or `privacy`), all the properties are optional. To edit the file itself, create a new revision using the appropriate method (`POST /v2/scores/{score}/revisions/{revision}`). When editing the `title` of the score, the API metadata are updated directly when calling this method, unlike the data itself. The title in the score data will be \"lazy\" updated at the next score save with the editor or our internal save. # @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`). # @param [Hash] opts the optional parameters # @option opts [ScoreModification] :body @@ -447,7 +447,7 @@ def edit_score(score, opts = {}) end # Edit a score's metadata - # This API method allows you to change the metadata of a score document (e.g. its `title` or `privacy`), all the properties are optional. To edit the file itself, create a new revision using the appropriate method (`POST /v2/scores/{score}/revisions/{revision}`). + # This API method allows you to change the metadata of a score document (e.g. its `title` or `privacy`), all the properties are optional. To edit the file itself, create a new revision using the appropriate method (`POST /v2/scores/{score}/revisions/{revision}`). When editing the `title` of the score, the API metadata are updated directly when calling this method, unlike the data itself. The title in the score data will be \"lazy\" updated at the next score save with the editor or our internal save. # @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`). # @param [Hash] opts the optional parameters # @option opts [ScoreModification] :body @@ -497,7 +497,7 @@ def edit_score_with_http_info(score, opts = {}) # @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`). # @param body # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [ScoreDetails] def fork_score(score, body, opts = {}) data, _status_code, _headers = fork_score_with_http_info(score, body, opts) @@ -509,7 +509,7 @@ def fork_score(score, body, opts = {}) # @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`). # @param body # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [Array<(ScoreDetails, Fixnum, Hash)>] ScoreDetails data, response status code and response headers def fork_score_with_http_info(score, body, opts = {}) if @api_client.config.debugging @@ -676,7 +676,7 @@ def get_group_scores_with_http_info(group, opts = {}) # Get the details of a score identified by the `score` parameter in the URL. The currently authenticated user must have at least a read access to the document to use this API call. # @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`). # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [ScoreDetails] def get_score(score, opts = {}) data, _status_code, _headers = get_score_with_http_info(score, opts) @@ -687,7 +687,7 @@ def get_score(score, opts = {}) # Get the details of a score identified by the `score` parameter in the URL. The currently authenticated user must have at least a read access to the document to use this API call. # @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`). # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [Array<(ScoreDetails, Fixnum, Hash)>] ScoreDetails data, response status code and response headers def get_score_with_http_info(score, opts = {}) if @api_client.config.debugging @@ -735,8 +735,8 @@ def get_score_with_http_info(score, opts = {}) # @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`). # @param collaborator Unique identifier of a **collaborator permission**, or unique identifier of a **User**, or unique identifier of a **Group** # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. - # @return [ScoreCollaborator] + # @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. + # @return [ResourceCollaborator] def get_score_collaborator(score, collaborator, opts = {}) data, _status_code, _headers = get_score_collaborator_with_http_info(score, collaborator, opts) return data @@ -747,8 +747,8 @@ def get_score_collaborator(score, collaborator, opts = {}) # @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`). # @param collaborator Unique identifier of a **collaborator permission**, or unique identifier of a **User**, or unique identifier of a **Group** # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. - # @return [Array<(ScoreCollaborator, Fixnum, Hash)>] ScoreCollaborator data, response status code and response headers + # @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. + # @return [Array<(ResourceCollaborator, Fixnum, Hash)>] ResourceCollaborator data, response status code and response headers def get_score_collaborator_with_http_info(score, collaborator, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ScoreApi.get_score_collaborator ..." @@ -787,7 +787,7 @@ def get_score_collaborator_with_http_info(score, collaborator, opts = {}) :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'ScoreCollaborator') + :return_type => 'ResourceCollaborator') if @api_client.config.debugging @api_client.config.logger.debug "API called: ScoreApi#get_score_collaborator\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end @@ -798,8 +798,8 @@ def get_score_collaborator_with_http_info(score, collaborator, opts = {}) # This API call will list the different collaborators of a score and their rights on the document. The returned list will at least contain the owner of the document. Collaborators can be a single user (the object `user` will be populated) or a group (the object `group` will be populated). # @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`). # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. - # @return [Array] + # @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. + # @return [Array] def get_score_collaborators(score, opts = {}) data, _status_code, _headers = get_score_collaborators_with_http_info(score, opts) return data @@ -809,8 +809,8 @@ def get_score_collaborators(score, opts = {}) # This API call will list the different collaborators of a score and their rights on the document. The returned list will at least contain the owner of the document. Collaborators can be a single user (the object `user` will be populated) or a group (the object `group` will be populated). # @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`). # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. - # @return [Array<(Array, Fixnum, Hash)>] Array data, response status code and response headers + # @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. + # @return [Array<(Array, Fixnum, Hash)>] Array data, response status code and response headers def get_score_collaborators_with_http_info(score, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ScoreApi.get_score_collaborators ..." @@ -845,7 +845,7 @@ def get_score_collaborators_with_http_info(score, opts = {}) :form_params => form_params, :body => post_body, :auth_names => auth_names, - :return_type => 'Array') + :return_type => 'Array') if @api_client.config.debugging @api_client.config.logger.debug "API called: ScoreApi#get_score_collaborators\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end @@ -856,7 +856,10 @@ def get_score_collaborators_with_http_info(score, opts = {}) # This method lists the different comments added on a music score (documents and inline) sorted by their post dates. # @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`). # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. + # @option opts [String] :type Filter the comments by type + # @option opts [String] :sort Sort + # @option opts [String] :direction Sort direction # @return [Array] def get_score_comments(score, opts = {}) data, _status_code, _headers = get_score_comments_with_http_info(score, opts) @@ -867,7 +870,10 @@ def get_score_comments(score, opts = {}) # This method lists the different comments added on a music score (documents and inline) sorted by their post dates. # @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`). # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. + # @option opts [String] :type Filter the comments by type + # @option opts [String] :sort Sort + # @option opts [String] :direction Sort direction # @return [Array<(Array, Fixnum, Hash)>] Array data, response status code and response headers def get_score_comments_with_http_info(score, opts = {}) if @api_client.config.debugging @@ -877,12 +883,24 @@ def get_score_comments_with_http_info(score, opts = {}) if @api_client.config.client_side_validation && score.nil? fail ArgumentError, "Missing the required parameter 'score' when calling ScoreApi.get_score_comments" end + if @api_client.config.client_side_validation && opts[:'type'] && !['document', 'inline'].include?(opts[:'type']) + fail ArgumentError, 'invalid value for "type", must be one of document, inline' + end + if @api_client.config.client_side_validation && opts[:'sort'] && !['date'].include?(opts[:'sort']) + fail ArgumentError, 'invalid value for "sort", must be one of date' + end + if @api_client.config.client_side_validation && opts[:'direction'] && !['asc', 'desc'].include?(opts[:'direction']) + fail ArgumentError, 'invalid value for "direction", must be one of asc, desc' + end # resource path local_var_path = "/scores/{score}/comments".sub('{' + 'score' + '}', score.to_s) # query parameters query_params = {} query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil? + query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil? + query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? + query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil? # header parameters header_params = {} @@ -915,7 +933,7 @@ def get_score_comments_with_http_info(score, opts = {}) # @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`). # @param revision Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [ScoreRevision] def get_score_revision(score, revision, opts = {}) data, _status_code, _headers = get_score_revision_with_http_info(score, revision, opts) @@ -927,7 +945,7 @@ def get_score_revision(score, revision, opts = {}) # @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`). # @param revision Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [Array<(ScoreRevision, Fixnum, Hash)>] ScoreRevision data, response status code and response headers def get_score_revision_with_http_info(score, revision, opts = {}) if @api_client.config.debugging @@ -980,9 +998,9 @@ def get_score_revision_with_http_info(score, revision, opts = {}) # @param revision Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. # @param format The format of the file you will retrieve # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. - # @option opts [BOOLEAN] :only_cached Only return files already generated and cached in Flat's production cache. If the file is not availabe, a 404 will be returned + # @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. # @option opts [String] :parts An optional a set of parts to be exported. This parameter must be specified with a list of integers. For example \"1,2,5\". + # @option opts [BOOLEAN] :only_cached Only return files already generated and cached in Flat's production cache. If the file is not availabe, a 404 will be returned # @return [String] def get_score_revision_data(score, revision, format, opts = {}) data, _status_code, _headers = get_score_revision_data_with_http_info(score, revision, format, opts) @@ -995,9 +1013,9 @@ def get_score_revision_data(score, revision, format, opts = {}) # @param revision Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. # @param format The format of the file you will retrieve # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. - # @option opts [BOOLEAN] :only_cached Only return files already generated and cached in Flat's production cache. If the file is not availabe, a 404 will be returned + # @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. # @option opts [String] :parts An optional a set of parts to be exported. This parameter must be specified with a list of integers. For example \"1,2,5\". + # @option opts [BOOLEAN] :only_cached Only return files already generated and cached in Flat's production cache. If the file is not availabe, a 404 will be returned # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers def get_score_revision_data_with_http_info(score, revision, format, opts = {}) if @api_client.config.debugging @@ -1025,8 +1043,8 @@ def get_score_revision_data_with_http_info(score, revision, format, opts = {}) # query parameters query_params = {} query_params[:'sharingKey'] = opts[:'sharing_key'] if !opts[:'sharing_key'].nil? - query_params[:'onlyCached'] = opts[:'only_cached'] if !opts[:'only_cached'].nil? query_params[:'parts'] = opts[:'parts'] if !opts[:'parts'].nil? + query_params[:'onlyCached'] = opts[:'only_cached'] if !opts[:'only_cached'].nil? # header parameters header_params = {} @@ -1058,7 +1076,7 @@ def get_score_revision_data_with_http_info(score, revision, format, opts = {}) # When creating a score or saving a new version of a score, a revision is created in our storage. This method allows you to list all of them, sorted by last modification. Depending the plan of the account, this list can be trunked to the few last revisions. # @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`). # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [Array] def get_score_revisions(score, opts = {}) data, _status_code, _headers = get_score_revisions_with_http_info(score, opts) @@ -1069,7 +1087,7 @@ def get_score_revisions(score, opts = {}) # When creating a score or saving a new version of a score, a revision is created in our storage. This method allows you to list all of them, sorted by last modification. Depending the plan of the account, this list can be trunked to the few last revisions. # @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`). # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [Array<(Array, Fixnum, Hash)>] Array data, response status code and response headers def get_score_revisions_with_http_info(score, opts = {}) if @api_client.config.debugging @@ -1172,7 +1190,7 @@ def get_score_submissions_with_http_info(score, opts = {}) # @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`). # @param track Unique identifier of a score audio track # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [ScoreTrack] def get_score_track(score, track, opts = {}) data, _status_code, _headers = get_score_track_with_http_info(score, track, opts) @@ -1184,7 +1202,7 @@ def get_score_track(score, track, opts = {}) # @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`). # @param track Unique identifier of a score audio track # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [Array<(ScoreTrack, Fixnum, Hash)>] ScoreTrack data, response status code and response headers def get_score_track_with_http_info(score, track, opts = {}) if @api_client.config.debugging @@ -1232,7 +1250,7 @@ def get_score_track_with_http_info(score, track, opts = {}) end # List user's scores - # Get the list of scores owned by the User + # Get the list of public scores owned by a User. **DEPRECATED**: Please note that the current behavior will be deprecrated on **2019-01-01**. This method will no longer list private and shared scores, but only public scores of a Flat account. If you want to access to private scores, please use the [Collections API](#tag/Collection) instead. # @param user Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user. # @param [Hash] opts the optional parameters # @option opts [String] :parent Filter the score forked from the score id `parent` @@ -1243,7 +1261,7 @@ def get_user_scores(user, opts = {}) end # List user's scores - # Get the list of scores owned by the User + # Get the list of public scores owned by a User. **DEPRECATED**: Please note that the current behavior will be deprecrated on **2019-01-01**. This method will no longer list private and shared scores, but only public scores of a Flat account. If you want to access to private scores, please use the [Collections API](#tag/Collection) instead. # @param user Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user. # @param [Hash] opts the optional parameters # @option opts [String] :parent Filter the score forked from the score id `parent` @@ -1293,7 +1311,7 @@ def get_user_scores_with_http_info(user, opts = {}) # # @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`). # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [Array] def list_score_tracks(score, opts = {}) data, _status_code, _headers = list_score_tracks_with_http_info(score, opts) @@ -1304,7 +1322,7 @@ def list_score_tracks(score, opts = {}) # # @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`). # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [Array<(Array, Fixnum, Hash)>] Array data, response status code and response headers def list_score_tracks_with_http_info(score, opts = {}) if @api_client.config.debugging @@ -1352,7 +1370,7 @@ def list_score_tracks_with_http_info(score, opts = {}) # @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`). # @param comment Unique identifier of a sheet music comment # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [nil] def mark_score_comment_resolved(score, comment, opts = {}) mark_score_comment_resolved_with_http_info(score, comment, opts) @@ -1364,7 +1382,7 @@ def mark_score_comment_resolved(score, comment, opts = {}) # @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`). # @param comment Unique identifier of a sheet music comment # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers def mark_score_comment_resolved_with_http_info(score, comment, opts = {}) if @api_client.config.debugging @@ -1415,7 +1433,7 @@ def mark_score_comment_resolved_with_http_info(score, comment, opts = {}) # @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`). # @param comment Unique identifier of a sheet music comment # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [nil] def mark_score_comment_unresolved(score, comment, opts = {}) mark_score_comment_unresolved_with_http_info(score, comment, opts) @@ -1427,7 +1445,7 @@ def mark_score_comment_unresolved(score, comment, opts = {}) # @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`). # @param comment Unique identifier of a sheet music comment # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers def mark_score_comment_unresolved_with_http_info(score, comment, opts = {}) if @api_client.config.debugging @@ -1478,7 +1496,7 @@ def mark_score_comment_unresolved_with_http_info(score, comment, opts = {}) # @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`). # @param body # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [ScoreComment] def post_score_comment(score, body, opts = {}) data, _status_code, _headers = post_score_comment_with_http_info(score, body, opts) @@ -1490,7 +1508,7 @@ def post_score_comment(score, body, opts = {}) # @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`). # @param body # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [Array<(ScoreComment, Fixnum, Hash)>] ScoreComment data, response status code and response headers def post_score_comment_with_http_info(score, body, opts = {}) if @api_client.config.debugging @@ -1597,13 +1615,67 @@ def remove_score_collaborator_with_http_info(score, collaborator, opts = {}) return data, status_code, headers end + # Untrash a score + # This method will remove the score from the `trash` collection and from the deletion queue, and add it back to the original collections. + # @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`). + # @param [Hash] opts the optional parameters + # @return [nil] + def untrash_score(score, opts = {}) + untrash_score_with_http_info(score, opts) + return nil + end + + # Untrash a score + # This method will remove the score from the `trash` collection and from the deletion queue, and add it back to the original collections. + # @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`). + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers + def untrash_score_with_http_info(score, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug "Calling API: ScoreApi.untrash_score ..." + end + # verify the required parameter 'score' is set + if @api_client.config.client_side_validation && score.nil? + fail ArgumentError, "Missing the required parameter 'score' when calling ScoreApi.untrash_score" + end + # resource path + local_var_path = "/scores/{score}/untrash".sub('{' + 'score' + '}', score.to_s) + + # query parameters + query_params = {} + + # header parameters + header_params = {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = {} + + # http body (model) + post_body = nil + auth_names = [] + data, status_code, headers = @api_client.call_api(:POST, local_var_path, + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: ScoreApi#untrash_score\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + # Update an existing comment # # @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`). # @param comment Unique identifier of a sheet music comment # @param body # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [ScoreComment] def update_score_comment(score, comment, body, opts = {}) data, _status_code, _headers = update_score_comment_with_http_info(score, comment, body, opts) @@ -1616,7 +1688,7 @@ def update_score_comment(score, comment, body, opts = {}) # @param comment Unique identifier of a sheet music comment # @param body # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [Array<(ScoreComment, Fixnum, Hash)>] ScoreComment data, response status code and response headers def update_score_comment_with_http_info(score, comment, body, opts = {}) if @api_client.config.debugging diff --git a/lib/flat_api/api/user_api.rb b/lib/flat_api/api/user_api.rb index f778aae..1df42a2 100644 --- a/lib/flat_api/api/user_api.rb +++ b/lib/flat_api/api/user_api.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT @@ -134,7 +134,7 @@ def get_user_with_http_info(user, opts = {}) end # List user's scores - # Get the list of scores owned by the User + # Get the list of public scores owned by a User. **DEPRECATED**: Please note that the current behavior will be deprecrated on **2019-01-01**. This method will no longer list private and shared scores, but only public scores of a Flat account. If you want to access to private scores, please use the [Collections API](#tag/Collection) instead. # @param user Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user. # @param [Hash] opts the optional parameters # @option opts [String] :parent Filter the score forked from the score id `parent` @@ -145,7 +145,7 @@ def get_user_scores(user, opts = {}) end # List user's scores - # Get the list of scores owned by the User + # Get the list of public scores owned by a User. **DEPRECATED**: Please note that the current behavior will be deprecrated on **2019-01-01**. This method will no longer list private and shared scores, but only public scores of a Flat account. If you want to access to private scores, please use the [Collections API](#tag/Collection) instead. # @param user Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user. # @param [Hash] opts the optional parameters # @option opts [String] :parent Filter the score forked from the score id `parent` diff --git a/lib/flat_api/api_client.rb b/lib/flat_api/api_client.rb index d6fe7fa..b957eae 100644 --- a/lib/flat_api/api_client.rb +++ b/lib/flat_api/api_client.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/api_error.rb b/lib/flat_api/api_error.rb index be4a8d1..e0f2d51 100644 --- a/lib/flat_api/api_error.rb +++ b/lib/flat_api/api_error.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/configuration.rb b/lib/flat_api/configuration.rb index c381199..a40bb93 100644 --- a/lib/flat_api/configuration.rb +++ b/lib/flat_api/configuration.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/assignment.rb b/lib/flat_api/models/assignment.rb index 897810a..6103a01 100644 --- a/lib/flat_api/models/assignment.rb +++ b/lib/flat_api/models/assignment.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/assignment_copy.rb b/lib/flat_api/models/assignment_copy.rb index fb26e21..4738df2 100644 --- a/lib/flat_api/models/assignment_copy.rb +++ b/lib/flat_api/models/assignment_copy.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/assignment_creation.rb b/lib/flat_api/models/assignment_creation.rb index 9892bf9..ae2dfc2 100644 --- a/lib/flat_api/models/assignment_creation.rb +++ b/lib/flat_api/models/assignment_creation.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/assignment_submission.rb b/lib/flat_api/models/assignment_submission.rb index 3e1dafe..9928d4e 100644 --- a/lib/flat_api/models/assignment_submission.rb +++ b/lib/flat_api/models/assignment_submission.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/assignment_submission_update.rb b/lib/flat_api/models/assignment_submission_update.rb index 40aff9d..695d2cb 100644 --- a/lib/flat_api/models/assignment_submission_update.rb +++ b/lib/flat_api/models/assignment_submission_update.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/class_attachment_creation.rb b/lib/flat_api/models/class_attachment_creation.rb index bc79ece..79163b5 100644 --- a/lib/flat_api/models/class_attachment_creation.rb +++ b/lib/flat_api/models/class_attachment_creation.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/class_creation.rb b/lib/flat_api/models/class_creation.rb index 8021245..2b30486 100644 --- a/lib/flat_api/models/class_creation.rb +++ b/lib/flat_api/models/class_creation.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/class_details.rb b/lib/flat_api/models/class_details.rb index c10b50c..03d947b 100644 --- a/lib/flat_api/models/class_details.rb +++ b/lib/flat_api/models/class_details.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/class_details_canvas.rb b/lib/flat_api/models/class_details_canvas.rb index 269b9f5..4560eaf 100644 --- a/lib/flat_api/models/class_details_canvas.rb +++ b/lib/flat_api/models/class_details_canvas.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/class_details_clever.rb b/lib/flat_api/models/class_details_clever.rb index 3f5f03c..850cb4c 100644 --- a/lib/flat_api/models/class_details_clever.rb +++ b/lib/flat_api/models/class_details_clever.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/class_details_google_classroom.rb b/lib/flat_api/models/class_details_google_classroom.rb index 7d9ec63..ee6b8e1 100644 --- a/lib/flat_api/models/class_details_google_classroom.rb +++ b/lib/flat_api/models/class_details_google_classroom.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/class_details_google_drive.rb b/lib/flat_api/models/class_details_google_drive.rb index 131c81a..51176f9 100644 --- a/lib/flat_api/models/class_details_google_drive.rb +++ b/lib/flat_api/models/class_details_google_drive.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/class_details_lti.rb b/lib/flat_api/models/class_details_lti.rb index 2e8c0a9..c28825d 100644 --- a/lib/flat_api/models/class_details_lti.rb +++ b/lib/flat_api/models/class_details_lti.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/class_roles.rb b/lib/flat_api/models/class_roles.rb index 8465487..24b5b03 100644 --- a/lib/flat_api/models/class_roles.rb +++ b/lib/flat_api/models/class_roles.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/class_state.rb b/lib/flat_api/models/class_state.rb index 68b8dad..f3c3631 100644 --- a/lib/flat_api/models/class_state.rb +++ b/lib/flat_api/models/class_state.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/class_update.rb b/lib/flat_api/models/class_update.rb index c9f997a..5331361 100644 --- a/lib/flat_api/models/class_update.rb +++ b/lib/flat_api/models/class_update.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/collection.rb b/lib/flat_api/models/collection.rb new file mode 100644 index 0000000..d87091a --- /dev/null +++ b/lib/flat_api/models/collection.rb @@ -0,0 +1,285 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require 'date' + +module FlatApi + # Collection of scores + class Collection + # Unique identifier of the collection + attr_accessor :id + + attr_accessor :title + + # The url where the collection can be viewed in a web browser + attr_accessor :html_url + + attr_accessor :type + + attr_accessor :privacy + + # The private sharing key of the collection (available when the `privacy` mode is set to `privateLink`) + attr_accessor :sharing_key + + # If this directory is dedicated to an app, the unique idenfier of this app + attr_accessor :app + + attr_accessor :user + + attr_accessor :rights + + # The list of the collaborators of the collection + attr_accessor :collaborators + + attr_accessor :capabilities + + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'id' => :'id', + :'title' => :'title', + :'html_url' => :'htmlUrl', + :'type' => :'type', + :'privacy' => :'privacy', + :'sharing_key' => :'sharingKey', + :'app' => :'app', + :'user' => :'user', + :'rights' => :'rights', + :'collaborators' => :'collaborators', + :'capabilities' => :'capabilities' + } + end + + # Attribute type mapping. + def self.swagger_types + { + :'id' => :'String', + :'title' => :'CollectionTitle', + :'html_url' => :'String', + :'type' => :'CollectionType', + :'privacy' => :'CollectionPrivacy', + :'sharing_key' => :'String', + :'app' => :'String', + :'user' => :'UserPublicSummary', + :'rights' => :'ResourceRights', + :'collaborators' => :'Array', + :'capabilities' => :'CollectionCapabilities' + } + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + return unless attributes.is_a?(Hash) + + # convert string to symbol for hash key + attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + + if attributes.has_key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.has_key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.has_key?(:'htmlUrl') + self.html_url = attributes[:'htmlUrl'] + end + + if attributes.has_key?(:'type') + self.type = attributes[:'type'] + end + + if attributes.has_key?(:'privacy') + self.privacy = attributes[:'privacy'] + end + + if attributes.has_key?(:'sharingKey') + self.sharing_key = attributes[:'sharingKey'] + end + + if attributes.has_key?(:'app') + self.app = attributes[:'app'] + end + + if attributes.has_key?(:'user') + self.user = attributes[:'user'] + end + + if attributes.has_key?(:'rights') + self.rights = attributes[:'rights'] + end + + if attributes.has_key?(:'collaborators') + if (value = attributes[:'collaborators']).is_a?(Array) + self.collaborators = value + end + end + + if attributes.has_key?(:'capabilities') + self.capabilities = attributes[:'capabilities'] + end + + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + return invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + id == o.id && + title == o.title && + html_url == o.html_url && + type == o.type && + privacy == o.privacy && + sharing_key == o.sharing_key && + app == o.app && + user == o.user && + rights == o.rights && + collaborators == o.collaborators && + capabilities == o.capabilities + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Fixnum] Hash code + def hash + [id, title, html_url, type, privacy, sharing_key, app, user, rights, collaborators, capabilities].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.swagger_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :BOOLEAN + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + temp_model = FlatApi.const_get(type).new + temp_model.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + next if value.nil? + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map{ |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/flat_api/models/collection_capabilities.rb b/lib/flat_api/models/collection_capabilities.rb new file mode 100644 index 0000000..bec7942 --- /dev/null +++ b/lib/flat_api/models/collection_capabilities.rb @@ -0,0 +1,229 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require 'date' + +module FlatApi + # Capabilities the current user has on this collection. Each capability corresponds to a fine-grained action that a user may take. + class CollectionCapabilities + # Whether the current user can modify the metadata for the collection + attr_accessor :can_edit + + # Whether the current user can modify the sharing settings for the collection + attr_accessor :can_share + + # Whether the current user can delete the collection + attr_accessor :can_delete + + # Whether the current user can add scores to the collection If this collection has the `type` `trash`, this property will be set to `false`. Use `DELETE /v2/scores/{score}` to trash a score. + attr_accessor :can_add_scores + + # Whether the current user can delete scores from the collection If this collection has the `type` `trash`, this property will be set to `false`. Use `POST /v2/scores/{score}/untrash` to restore a score. + attr_accessor :can_delete_scores + + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'can_edit' => :'canEdit', + :'can_share' => :'canShare', + :'can_delete' => :'canDelete', + :'can_add_scores' => :'canAddScores', + :'can_delete_scores' => :'canDeleteScores' + } + end + + # Attribute type mapping. + def self.swagger_types + { + :'can_edit' => :'BOOLEAN', + :'can_share' => :'BOOLEAN', + :'can_delete' => :'BOOLEAN', + :'can_add_scores' => :'BOOLEAN', + :'can_delete_scores' => :'BOOLEAN' + } + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + return unless attributes.is_a?(Hash) + + # convert string to symbol for hash key + attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + + if attributes.has_key?(:'canEdit') + self.can_edit = attributes[:'canEdit'] + end + + if attributes.has_key?(:'canShare') + self.can_share = attributes[:'canShare'] + end + + if attributes.has_key?(:'canDelete') + self.can_delete = attributes[:'canDelete'] + end + + if attributes.has_key?(:'canAddScores') + self.can_add_scores = attributes[:'canAddScores'] + end + + if attributes.has_key?(:'canDeleteScores') + self.can_delete_scores = attributes[:'canDeleteScores'] + end + + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + return invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + can_edit == o.can_edit && + can_share == o.can_share && + can_delete == o.can_delete && + can_add_scores == o.can_add_scores && + can_delete_scores == o.can_delete_scores + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Fixnum] Hash code + def hash + [can_edit, can_share, can_delete, can_add_scores, can_delete_scores].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.swagger_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :BOOLEAN + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + temp_model = FlatApi.const_get(type).new + temp_model.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + next if value.nil? + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map{ |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/flat_api/models/collection_creation.rb b/lib/flat_api/models/collection_creation.rb new file mode 100644 index 0000000..4e7e032 --- /dev/null +++ b/lib/flat_api/models/collection_creation.rb @@ -0,0 +1,193 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require 'date' + +module FlatApi + + class CollectionCreation + attr_accessor :title + + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'title' => :'title' + } + end + + # Attribute type mapping. + def self.swagger_types + { + :'title' => :'CollectionTitle' + } + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + return unless attributes.is_a?(Hash) + + # convert string to symbol for hash key + attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + + if attributes.has_key?(:'title') + self.title = attributes[:'title'] + end + + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + if @title.nil? + invalid_properties.push("invalid value for 'title', title cannot be nil.") + end + + return invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return false if @title.nil? + return true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + title == o.title + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Fixnum] Hash code + def hash + [title].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.swagger_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :BOOLEAN + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + temp_model = FlatApi.const_get(type).new + temp_model.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + next if value.nil? + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map{ |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/flat_api/models/collection_modification.rb b/lib/flat_api/models/collection_modification.rb new file mode 100644 index 0000000..fb02932 --- /dev/null +++ b/lib/flat_api/models/collection_modification.rb @@ -0,0 +1,188 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require 'date' + +module FlatApi + # Edit the collection metadata + class CollectionModification + attr_accessor :title + + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'title' => :'title' + } + end + + # Attribute type mapping. + def self.swagger_types + { + :'title' => :'CollectionTitle' + } + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + return unless attributes.is_a?(Hash) + + # convert string to symbol for hash key + attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + + if attributes.has_key?(:'title') + self.title = attributes[:'title'] + end + + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + return invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + title == o.title + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Fixnum] Hash code + def hash + [title].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.swagger_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :BOOLEAN + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + temp_model = FlatApi.const_get(type).new + temp_model.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + next if value.nil? + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map{ |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/flat_api/models/collection_privacy.rb b/lib/flat_api/models/collection_privacy.rb new file mode 100644 index 0000000..4936e48 --- /dev/null +++ b/lib/flat_api/models/collection_privacy.rb @@ -0,0 +1,30 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require 'date' + +module FlatApi + class CollectionPrivacy + + PRIVATE = "private".freeze + + # Builds the enum from string + # @param [String] The enum value in the form of the string + # @return [String] The enum value + def build_from_hash(value) + constantValues = CollectionPrivacy.constants.select{|c| CollectionPrivacy::const_get(c) == value} + raise "Invalid ENUM value #{value} for class #CollectionPrivacy" if constantValues.empty? + value + end + end + +end diff --git a/lib/flat_api/models/collection_title.rb b/lib/flat_api/models/collection_title.rb new file mode 100644 index 0000000..6290b72 --- /dev/null +++ b/lib/flat_api/models/collection_title.rb @@ -0,0 +1,179 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require 'date' + +module FlatApi + # The title of the collection + class CollectionTitle + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + } + end + + # Attribute type mapping. + def self.swagger_types + { + } + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + return unless attributes.is_a?(Hash) + + # convert string to symbol for hash key + attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + return invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Fixnum] Hash code + def hash + [].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.swagger_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :BOOLEAN + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + temp_model = FlatApi.const_get(type).new + temp_model.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + next if value.nil? + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map{ |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/flat_api/models/collection_type.rb b/lib/flat_api/models/collection_type.rb new file mode 100644 index 0000000..e0c3f36 --- /dev/null +++ b/lib/flat_api/models/collection_type.rb @@ -0,0 +1,34 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require 'date' + +module FlatApi + class CollectionType + + ROOT = "root".freeze + REGULAR = "regular".freeze + SHARED_WITH_ME = "sharedWithMe".freeze + SHARED_WITH_GROUP = "sharedWithGroup".freeze + TRASH = "trash".freeze + + # Builds the enum from string + # @param [String] The enum value in the form of the string + # @return [String] The enum value + def build_from_hash(value) + constantValues = CollectionType.constants.select{|c| CollectionType::const_get(c) == value} + raise "Invalid ENUM value #{value} for class #CollectionType" if constantValues.empty? + value + end + end + +end diff --git a/lib/flat_api/models/flat_error_response.rb b/lib/flat_api/models/flat_error_response.rb index f99941e..fffe18b 100644 --- a/lib/flat_api/models/flat_error_response.rb +++ b/lib/flat_api/models/flat_error_response.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/flat_locales.rb b/lib/flat_api/models/flat_locales.rb index bb98dac..5f83c57 100644 --- a/lib/flat_api/models/flat_locales.rb +++ b/lib/flat_api/models/flat_locales.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/google_classroom_coursework.rb b/lib/flat_api/models/google_classroom_coursework.rb index aba0782..218cf5e 100644 --- a/lib/flat_api/models/google_classroom_coursework.rb +++ b/lib/flat_api/models/google_classroom_coursework.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/google_classroom_submission.rb b/lib/flat_api/models/google_classroom_submission.rb index 14ee322..dd23cd6 100644 --- a/lib/flat_api/models/google_classroom_submission.rb +++ b/lib/flat_api/models/google_classroom_submission.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/group.rb b/lib/flat_api/models/group.rb index eaad3da..b58deb0 100644 --- a/lib/flat_api/models/group.rb +++ b/lib/flat_api/models/group.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/group_details.rb b/lib/flat_api/models/group_details.rb index 4f9b955..0af40be 100644 --- a/lib/flat_api/models/group_details.rb +++ b/lib/flat_api/models/group_details.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/group_type.rb b/lib/flat_api/models/group_type.rb index 7969448..bdf0b9b 100644 --- a/lib/flat_api/models/group_type.rb +++ b/lib/flat_api/models/group_type.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/license_mode.rb b/lib/flat_api/models/license_mode.rb index 71e7db3..0538d94 100644 --- a/lib/flat_api/models/license_mode.rb +++ b/lib/flat_api/models/license_mode.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/license_sources.rb b/lib/flat_api/models/license_sources.rb index da51b42..ca9f208 100644 --- a/lib/flat_api/models/license_sources.rb +++ b/lib/flat_api/models/license_sources.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/lms_name.rb b/lib/flat_api/models/lms_name.rb index 566c6e2..402f29e 100644 --- a/lib/flat_api/models/lms_name.rb +++ b/lib/flat_api/models/lms_name.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/lti_credentials.rb b/lib/flat_api/models/lti_credentials.rb index d4efe10..866b269 100644 --- a/lib/flat_api/models/lti_credentials.rb +++ b/lib/flat_api/models/lti_credentials.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/lti_credentials_creation.rb b/lib/flat_api/models/lti_credentials_creation.rb index 3811770..a1f3d28 100644 --- a/lib/flat_api/models/lti_credentials_creation.rb +++ b/lib/flat_api/models/lti_credentials_creation.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/media_attachment.rb b/lib/flat_api/models/media_attachment.rb index 0c4fc5b..0989c28 100644 --- a/lib/flat_api/models/media_attachment.rb +++ b/lib/flat_api/models/media_attachment.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/media_score_sharing_mode.rb b/lib/flat_api/models/media_score_sharing_mode.rb index 7146dd9..2afdeb7 100644 --- a/lib/flat_api/models/media_score_sharing_mode.rb +++ b/lib/flat_api/models/media_score_sharing_mode.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/organization_invitation.rb b/lib/flat_api/models/organization_invitation.rb index 95b25fd..4096d8f 100644 --- a/lib/flat_api/models/organization_invitation.rb +++ b/lib/flat_api/models/organization_invitation.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/organization_invitation_creation.rb b/lib/flat_api/models/organization_invitation_creation.rb index 05401f4..0a812eb 100644 --- a/lib/flat_api/models/organization_invitation_creation.rb +++ b/lib/flat_api/models/organization_invitation_creation.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/organization_roles.rb b/lib/flat_api/models/organization_roles.rb index 3f37d0e..92bdb73 100644 --- a/lib/flat_api/models/organization_roles.rb +++ b/lib/flat_api/models/organization_roles.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_collaborator.rb b/lib/flat_api/models/resource_collaborator.rb similarity index 84% rename from lib/flat_api/models/score_collaborator.rb rename to lib/flat_api/models/resource_collaborator.rb index 8ce671a..209835c 100644 --- a/lib/flat_api/models/score_collaborator.rb +++ b/lib/flat_api/models/resource_collaborator.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT @@ -14,13 +14,25 @@ module FlatApi # A collaborator of a score. The `userEmail` and `group` are only available if the requesting user is a collaborator of the related score (in this case these permissions will eventualy not be listed and exposed publicly). - class ScoreCollaborator - # The unique identifier of the score permission + class ResourceCollaborator + # `True` if the current user can read the current document + attr_accessor :acl_read + + # `True` if the current user can modify the current document. If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection. + attr_accessor :acl_write + + # `True` if the current user can manage the current document (i.e. share, delete) If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection. + attr_accessor :acl_admin + + # The unique identifier of the permission attr_accessor :id - # The unique identifier of the score + # If this object is a permission of a score, this property will contain the unique identifier of the score attr_accessor :score + # If this object is a permission of a collection, this property will contain the unique identifier of the collection + attr_accessor :collection + attr_accessor :user attr_accessor :group @@ -28,41 +40,34 @@ class ScoreCollaborator # If the collaborator is not a user of Flat yet, this field will contain his email. attr_accessor :user_email - # `True` if the related user can read the score. (probably true if the user has a permission on the document). - attr_accessor :acl_read - - # `True` if the related user can modify the score. - attr_accessor :acl_write - - # `True` if the related user can can manage the current document, i.e. changing the document permissions and deleting the document - attr_accessor :acl_admin - # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { + :'acl_read' => :'aclRead', + :'acl_write' => :'aclWrite', + :'acl_admin' => :'aclAdmin', :'id' => :'id', :'score' => :'score', + :'collection' => :'collection', :'user' => :'user', :'group' => :'group', - :'user_email' => :'userEmail', - :'acl_read' => :'aclRead', - :'acl_write' => :'aclWrite', - :'acl_admin' => :'aclAdmin' + :'user_email' => :'userEmail' } end # Attribute type mapping. def self.swagger_types { + :'acl_read' => :'BOOLEAN', + :'acl_write' => :'BOOLEAN', + :'acl_admin' => :'BOOLEAN', :'id' => :'String', :'score' => :'String', + :'collection' => :'String', :'user' => :'UserPublic', :'group' => :'Group', - :'user_email' => :'String', - :'acl_read' => :'BOOLEAN', - :'acl_write' => :'BOOLEAN', - :'acl_admin' => :'BOOLEAN' + :'user_email' => :'String' } end @@ -74,6 +79,24 @@ def initialize(attributes = {}) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + if attributes.has_key?(:'aclRead') + self.acl_read = attributes[:'aclRead'] + else + self.acl_read = false + end + + if attributes.has_key?(:'aclWrite') + self.acl_write = attributes[:'aclWrite'] + else + self.acl_write = false + end + + if attributes.has_key?(:'aclAdmin') + self.acl_admin = attributes[:'aclAdmin'] + else + self.acl_admin = false + end + if attributes.has_key?(:'id') self.id = attributes[:'id'] end @@ -82,6 +105,10 @@ def initialize(attributes = {}) self.score = attributes[:'score'] end + if attributes.has_key?(:'collection') + self.collection = attributes[:'collection'] + end + if attributes.has_key?(:'user') self.user = attributes[:'user'] end @@ -94,24 +121,6 @@ def initialize(attributes = {}) self.user_email = attributes[:'userEmail'] end - if attributes.has_key?(:'aclRead') - self.acl_read = attributes[:'aclRead'] - else - self.acl_read = true - end - - if attributes.has_key?(:'aclWrite') - self.acl_write = attributes[:'aclWrite'] - else - self.acl_write = false - end - - if attributes.has_key?(:'aclAdmin') - self.acl_admin = attributes[:'aclAdmin'] - else - self.acl_admin = false - end - end # Show invalid properties with the reasons. Usually used together with valid? @@ -132,14 +141,15 @@ def valid? def ==(o) return true if self.equal?(o) self.class == o.class && + acl_read == o.acl_read && + acl_write == o.acl_write && + acl_admin == o.acl_admin && id == o.id && score == o.score && + collection == o.collection && user == o.user && group == o.group && - user_email == o.user_email && - acl_read == o.acl_read && - acl_write == o.acl_write && - acl_admin == o.acl_admin + user_email == o.user_email end # @see the `==` method @@ -151,7 +161,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Fixnum] Hash code def hash - [id, score, user, group, user_email, acl_read, acl_write, acl_admin].hash + [acl_read, acl_write, acl_admin, id, score, collection, user, group, user_email].hash end # Builds the object from hash diff --git a/lib/flat_api/models/score_collaborator_creation.rb b/lib/flat_api/models/resource_collaborator_creation.rb similarity index 94% rename from lib/flat_api/models/score_collaborator_creation.rb rename to lib/flat_api/models/resource_collaborator_creation.rb index b4c413f..5b07f7a 100644 --- a/lib/flat_api/models/score_collaborator_creation.rb +++ b/lib/flat_api/models/resource_collaborator_creation.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT @@ -13,8 +13,8 @@ require 'date' module FlatApi - # A collaborator of a score. The `userEmail` and `group` are only available if the requesting user is a collaborator of the related score (in this case these permissions will eventualy not be listed and exposed publicly). - class ScoreCollaboratorCreation + # Add a collaborator to a resource. + class ResourceCollaboratorCreation # The unique identifier of a Flat user attr_accessor :user @@ -24,6 +24,9 @@ class ScoreCollaboratorCreation # Fill this field to invite an individual user by email. attr_accessor :user_email + # Token received in an invitation to join the score. + attr_accessor :user_token + # `True` if the related user can read the score. (probably true if the user has a permission on the document). attr_accessor :acl_read @@ -40,6 +43,7 @@ def self.attribute_map :'user' => :'user', :'group' => :'group', :'user_email' => :'userEmail', + :'user_token' => :'userToken', :'acl_read' => :'aclRead', :'acl_write' => :'aclWrite', :'acl_admin' => :'aclAdmin' @@ -52,6 +56,7 @@ def self.swagger_types :'user' => :'String', :'group' => :'String', :'user_email' => :'String', + :'user_token' => :'String', :'acl_read' => :'BOOLEAN', :'acl_write' => :'BOOLEAN', :'acl_admin' => :'BOOLEAN' @@ -78,6 +83,10 @@ def initialize(attributes = {}) self.user_email = attributes[:'userEmail'] end + if attributes.has_key?(:'userToken') + self.user_token = attributes[:'userToken'] + end + if attributes.has_key?(:'aclRead') self.acl_read = attributes[:'aclRead'] else @@ -119,6 +128,7 @@ def ==(o) user == o.user && group == o.group && user_email == o.user_email && + user_token == o.user_token && acl_read == o.acl_read && acl_write == o.acl_write && acl_admin == o.acl_admin @@ -133,7 +143,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Fixnum] Hash code def hash - [user, group, user_email, acl_read, acl_write, acl_admin].hash + [user, group, user_email, user_token, acl_read, acl_write, acl_admin].hash end # Builds the object from hash diff --git a/lib/flat_api/models/score_rights.rb b/lib/flat_api/models/resource_rights.rb similarity index 92% rename from lib/flat_api/models/score_rights.rb rename to lib/flat_api/models/resource_rights.rb index 4b65c74..74f033e 100644 --- a/lib/flat_api/models/score_rights.rb +++ b/lib/flat_api/models/resource_rights.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT @@ -13,15 +13,15 @@ require 'date' module FlatApi - # The rights of the current user on a score - class ScoreRights + # The rights of the current user on a score or collection + class ResourceRights # `True` if the current user can read the current document attr_accessor :acl_read - # `True` if the current user can modify the current document + # `True` if the current user can modify the current document. If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection. attr_accessor :acl_write - # `True` if the current user can manage the current document, i.e. changing the document permissions and deleting the document + # `True` if the current user can manage the current document (i.e. share, delete) If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection. attr_accessor :acl_admin @@ -54,7 +54,7 @@ def initialize(attributes = {}) if attributes.has_key?(:'aclRead') self.acl_read = attributes[:'aclRead'] else - self.acl_read = true + self.acl_read = false end if attributes.has_key?(:'aclWrite') diff --git a/lib/flat_api/models/resource_sharing_key.rb b/lib/flat_api/models/resource_sharing_key.rb new file mode 100644 index 0000000..155155b --- /dev/null +++ b/lib/flat_api/models/resource_sharing_key.rb @@ -0,0 +1,179 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require 'date' + +module FlatApi + # When using the `privacy` mode `privateLink`, this property can be used to set a custom sharing key, otherwise a new key will be generated. + class ResourceSharingKey + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + } + end + + # Attribute type mapping. + def self.swagger_types + { + } + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + return unless attributes.is_a?(Hash) + + # convert string to symbol for hash key + attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + return invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + return true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Fixnum] Hash code + def hash + [].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.swagger_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } ) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :BOOLEAN + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + temp_model = FlatApi.const_get(type).new + temp_model.build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + next if value.nil? + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map{ |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + + end + +end diff --git a/lib/flat_api/models/score_comment.rb b/lib/flat_api/models/score_comment.rb index 04e744a..8a63868 100644 --- a/lib/flat_api/models/score_comment.rb +++ b/lib/flat_api/models/score_comment.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_comment_context.rb b/lib/flat_api/models/score_comment_context.rb index f0c5c26..4f62b90 100644 --- a/lib/flat_api/models/score_comment_context.rb +++ b/lib/flat_api/models/score_comment_context.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_comment_creation.rb b/lib/flat_api/models/score_comment_creation.rb index 289bda7..b12d1e6 100644 --- a/lib/flat_api/models/score_comment_creation.rb +++ b/lib/flat_api/models/score_comment_creation.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_comment_update.rb b/lib/flat_api/models/score_comment_update.rb index fbe4434..bfc5ffe 100644 --- a/lib/flat_api/models/score_comment_update.rb +++ b/lib/flat_api/models/score_comment_update.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_comments_counts.rb b/lib/flat_api/models/score_comments_counts.rb index 31544bb..51d0a23 100644 --- a/lib/flat_api/models/score_comments_counts.rb +++ b/lib/flat_api/models/score_comments_counts.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_creation.rb b/lib/flat_api/models/score_creation.rb index 79c65dc..0691ffd 100644 --- a/lib/flat_api/models/score_creation.rb +++ b/lib/flat_api/models/score_creation.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT @@ -15,7 +15,7 @@ module FlatApi # A new created score class ScoreCreation - # The title of the new score. If this title is not specified, the API will try to (in this order): - Use the name of the file for files from a specified `source` (e.g. Google Drive) - Use the title contained in the file (e.g. [`movement-title`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-movement-title.htm) or [`credit-words`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-credit-words.htm) for [MusicXML](http://www.musicxml.com/) files). - Set a default title (e.g. \"New Music Score\") If the title is already used, the API will append the creation date after the title. If the title is too long, the API may trim this one. + # The title of the new score. If the title is too long, the API may trim this one. If this title is not specified, the API will try to (in this order): - Use the name of the file for files from a specified `source` (e.g. Google Drive) - Use the title contained in the file (e.g. [`movement-title`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-movement-title.htm) or [`credit-words`](https://usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-credit-words.htm) for [MusicXML](http://www.musicxml.com/) files). - Set a default title (e.g. \"New Music Score\") attr_accessor :title attr_accessor :privacy @@ -26,6 +26,9 @@ class ScoreCreation attr_accessor :source + # Unique identifier of a collection where the score will be created. If no collection identifier is provided, the score will be stored in the `root` directory. + attr_accessor :collection + # If the user uses Google Drive and this properties is specified, the file will be created in this directory. The currently user creating the file must be granted to write in this directory. attr_accessor :google_drive_folder @@ -38,6 +41,7 @@ def self.attribute_map :'data' => :'data', :'data_encoding' => :'dataEncoding', :'source' => :'source', + :'collection' => :'collection', :'google_drive_folder' => :'googleDriveFolder' } end @@ -50,6 +54,7 @@ def self.swagger_types :'data' => :'ScoreData', :'data_encoding' => :'ScoreDataEncoding', :'source' => :'ScoreSource', + :'collection' => :'String', :'google_drive_folder' => :'String' } end @@ -82,6 +87,10 @@ def initialize(attributes = {}) self.source = attributes[:'source'] end + if attributes.has_key?(:'collection') + self.collection = attributes[:'collection'] + end + if attributes.has_key?(:'googleDriveFolder') self.google_drive_folder = attributes[:'googleDriveFolder'] end @@ -116,6 +125,7 @@ def ==(o) data == o.data && data_encoding == o.data_encoding && source == o.source && + collection == o.collection && google_drive_folder == o.google_drive_folder end @@ -128,7 +138,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Fixnum] Hash code def hash - [title, privacy, data, data_encoding, source, google_drive_folder].hash + [title, privacy, data, data_encoding, source, collection, google_drive_folder].hash end # Builds the object from hash diff --git a/lib/flat_api/models/score_creation_type.rb b/lib/flat_api/models/score_creation_type.rb index 64575ec..c0dd5ac 100644 --- a/lib/flat_api/models/score_creation_type.rb +++ b/lib/flat_api/models/score_creation_type.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_data.rb b/lib/flat_api/models/score_data.rb index da1efb2..e0c15e0 100644 --- a/lib/flat_api/models/score_data.rb +++ b/lib/flat_api/models/score_data.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_data_encoding.rb b/lib/flat_api/models/score_data_encoding.rb index 343cab3..0942a32 100644 --- a/lib/flat_api/models/score_data_encoding.rb +++ b/lib/flat_api/models/score_data_encoding.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_details.rb b/lib/flat_api/models/score_details.rb index 6989bfb..8969edb 100644 --- a/lib/flat_api/models/score_details.rb +++ b/lib/flat_api/models/score_details.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT @@ -150,8 +150,8 @@ def self.swagger_types :'duration_time' => :'Integer', :'number_measures' => :'Integer', :'main_tempo_qpm' => :'Integer', - :'rights' => :'ScoreRights', - :'collaborators' => :'Array', + :'rights' => :'ResourceRights', + :'collaborators' => :'Array', :'creation_date' => :'DateTime', :'modification_date' => :'DateTime', :'publication_date' => :'DateTime', diff --git a/lib/flat_api/models/score_fork.rb b/lib/flat_api/models/score_fork.rb index 0e694fe..71c8866 100644 --- a/lib/flat_api/models/score_fork.rb +++ b/lib/flat_api/models/score_fork.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT @@ -15,16 +15,21 @@ module FlatApi # Options to fork the score class ScoreFork + # Unique identifier of a collection where the score will be copied. If no collection identifier is provided, the score will be stored in the `root` directory. + attr_accessor :collection + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { + :'collection' => :'collection' } end # Attribute type mapping. def self.swagger_types { + :'collection' => :'String' } end @@ -36,6 +41,10 @@ def initialize(attributes = {}) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + if attributes.has_key?(:'collection') + self.collection = attributes[:'collection'] + end + end # Show invalid properties with the reasons. Usually used together with valid? @@ -55,7 +64,8 @@ def valid? # @param [Object] Object to be compared def ==(o) return true if self.equal?(o) - self.class == o.class + self.class == o.class && + collection == o.collection end # @see the `==` method @@ -67,7 +77,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Fixnum] Hash code def hash - [].hash + [collection].hash end # Builds the object from hash diff --git a/lib/flat_api/models/score_license.rb b/lib/flat_api/models/score_license.rb index 5e47bc2..1bca710 100644 --- a/lib/flat_api/models/score_license.rb +++ b/lib/flat_api/models/score_license.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_likes_counts.rb b/lib/flat_api/models/score_likes_counts.rb index 88c3df0..a28c848 100644 --- a/lib/flat_api/models/score_likes_counts.rb +++ b/lib/flat_api/models/score_likes_counts.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_modification.rb b/lib/flat_api/models/score_modification.rb index 797afe6..7413f52 100644 --- a/lib/flat_api/models/score_modification.rb +++ b/lib/flat_api/models/score_modification.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT @@ -15,9 +15,11 @@ module FlatApi # Edit the score metadata class ScoreModification + # The title of the score + attr_accessor :title + attr_accessor :privacy - # When using the `privacy` mode `privateLink`, this property can be used to set a custom sharing key, otherwise a new key will be generated. attr_accessor :sharing_key # Description of the creation @@ -34,6 +36,7 @@ class ScoreModification # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { + :'title' => :'title', :'privacy' => :'privacy', :'sharing_key' => :'sharingKey', :'description' => :'description', @@ -46,8 +49,9 @@ def self.attribute_map # Attribute type mapping. def self.swagger_types { + :'title' => :'String', :'privacy' => :'ScorePrivacy', - :'sharing_key' => :'String', + :'sharing_key' => :'ResourceSharingKey', :'description' => :'String', :'tags' => :'Array', :'creation_type' => :'ScoreCreationType', @@ -63,6 +67,10 @@ def initialize(attributes = {}) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} + if attributes.has_key?(:'title') + self.title = attributes[:'title'] + end + if attributes.has_key?(:'privacy') self.privacy = attributes[:'privacy'] end @@ -95,10 +103,6 @@ def initialize(attributes = {}) # @return Array for valid properties with the reasons def list_invalid_properties invalid_properties = Array.new - if !@sharing_key.nil? && @sharing_key !~ Regexp.new(/^[a-f0-9]{128}$/) - invalid_properties.push("invalid value for 'sharing_key', must conform to the pattern /^[a-f0-9]{128}$/.") - end - if !@description.nil? && @description.to_s.length > 1000 invalid_properties.push("invalid value for 'description', the character length must be smaller than or equal to 1000.") end @@ -109,22 +113,10 @@ def list_invalid_properties # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? - return false if !@sharing_key.nil? && @sharing_key !~ Regexp.new(/^[a-f0-9]{128}$/) return false if !@description.nil? && @description.to_s.length > 1000 return true end - # Custom attribute writer method with validation - # @param [Object] sharing_key Value to be assigned - def sharing_key=(sharing_key) - - if !sharing_key.nil? && sharing_key !~ Regexp.new(/^[a-f0-9]{128}$/) - fail ArgumentError, "invalid value for 'sharing_key', must conform to the pattern /^[a-f0-9]{128}$/." - end - - @sharing_key = sharing_key - end - # Custom attribute writer method with validation # @param [Object] description Value to be assigned def description=(description) @@ -141,6 +133,7 @@ def description=(description) def ==(o) return true if self.equal?(o) self.class == o.class && + title == o.title && privacy == o.privacy && sharing_key == o.sharing_key && description == o.description && @@ -158,7 +151,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Fixnum] Hash code def hash - [privacy, sharing_key, description, tags, creation_type, license].hash + [title, privacy, sharing_key, description, tags, creation_type, license].hash end # Builds the object from hash diff --git a/lib/flat_api/models/score_privacy.rb b/lib/flat_api/models/score_privacy.rb index cc262ce..a271c57 100644 --- a/lib/flat_api/models/score_privacy.rb +++ b/lib/flat_api/models/score_privacy.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_revision.rb b/lib/flat_api/models/score_revision.rb index 76d602c..fd153fe 100644 --- a/lib/flat_api/models/score_revision.rb +++ b/lib/flat_api/models/score_revision.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_revision_creation.rb b/lib/flat_api/models/score_revision_creation.rb index b724374..913876b 100644 --- a/lib/flat_api/models/score_revision_creation.rb +++ b/lib/flat_api/models/score_revision_creation.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_revision_statistics.rb b/lib/flat_api/models/score_revision_statistics.rb index 33d8c61..9ef443e 100644 --- a/lib/flat_api/models/score_revision_statistics.rb +++ b/lib/flat_api/models/score_revision_statistics.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_source.rb b/lib/flat_api/models/score_source.rb index 0b293fc..49ccc6f 100644 --- a/lib/flat_api/models/score_source.rb +++ b/lib/flat_api/models/score_source.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_summary.rb b/lib/flat_api/models/score_summary.rb index 37d1b58..32d146b 100644 --- a/lib/flat_api/models/score_summary.rb +++ b/lib/flat_api/models/score_summary.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_track.rb b/lib/flat_api/models/score_track.rb index 60834a2..1bf0200 100644 --- a/lib/flat_api/models/score_track.rb +++ b/lib/flat_api/models/score_track.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_track_creation.rb b/lib/flat_api/models/score_track_creation.rb index 1afc40b..73dd8f4 100644 --- a/lib/flat_api/models/score_track_creation.rb +++ b/lib/flat_api/models/score_track_creation.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_track_point.rb b/lib/flat_api/models/score_track_point.rb index 9bc1090..a35d75b 100644 --- a/lib/flat_api/models/score_track_point.rb +++ b/lib/flat_api/models/score_track_point.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_track_state.rb b/lib/flat_api/models/score_track_state.rb index 285a381..b8013d4 100644 --- a/lib/flat_api/models/score_track_state.rb +++ b/lib/flat_api/models/score_track_state.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_track_type.rb b/lib/flat_api/models/score_track_type.rb index f9364e6..3b6d52d 100644 --- a/lib/flat_api/models/score_track_type.rb +++ b/lib/flat_api/models/score_track_type.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_track_update.rb b/lib/flat_api/models/score_track_update.rb index 6ca9657..c1f1c35 100644 --- a/lib/flat_api/models/score_track_update.rb +++ b/lib/flat_api/models/score_track_update.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/score_views_counts.rb b/lib/flat_api/models/score_views_counts.rb index 822f3cc..224bda7 100644 --- a/lib/flat_api/models/score_views_counts.rb +++ b/lib/flat_api/models/score_views_counts.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/user_admin_update.rb b/lib/flat_api/models/user_admin_update.rb index fec5b5f..4a4b1ac 100644 --- a/lib/flat_api/models/user_admin_update.rb +++ b/lib/flat_api/models/user_admin_update.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/user_basics.rb b/lib/flat_api/models/user_basics.rb index 9952d94..2be72d6 100644 --- a/lib/flat_api/models/user_basics.rb +++ b/lib/flat_api/models/user_basics.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/user_creation.rb b/lib/flat_api/models/user_creation.rb index 5d6d8e7..15dea16 100644 --- a/lib/flat_api/models/user_creation.rb +++ b/lib/flat_api/models/user_creation.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/user_details.rb b/lib/flat_api/models/user_details.rb index a4abe86..0343514 100644 --- a/lib/flat_api/models/user_details.rb +++ b/lib/flat_api/models/user_details.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/user_details_admin.rb b/lib/flat_api/models/user_details_admin.rb index f724678..5a87364 100644 --- a/lib/flat_api/models/user_details_admin.rb +++ b/lib/flat_api/models/user_details_admin.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/user_details_admin_license.rb b/lib/flat_api/models/user_details_admin_license.rb index f006e90..081e88b 100644 --- a/lib/flat_api/models/user_details_admin_license.rb +++ b/lib/flat_api/models/user_details_admin_license.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/user_instruments.rb b/lib/flat_api/models/user_instruments.rb index a97ee0b..2cba6bf 100644 --- a/lib/flat_api/models/user_instruments.rb +++ b/lib/flat_api/models/user_instruments.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/user_public.rb b/lib/flat_api/models/user_public.rb index b1c4e8b..5903f0c 100644 --- a/lib/flat_api/models/user_public.rb +++ b/lib/flat_api/models/user_public.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/models/user_public_summary.rb b/lib/flat_api/models/user_public_summary.rb index d8ada9e..cd67a8f 100644 --- a/lib/flat_api/models/user_public_summary.rb +++ b/lib/flat_api/models/user_public_summary.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT diff --git a/lib/flat_api/version.rb b/lib/flat_api/version.rb index 9959b51..86b2203 100644 --- a/lib/flat_api/version.rb +++ b/lib/flat_api/version.rb @@ -3,7 +3,7 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.2 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.0-SNAPSHOT @@ -11,5 +11,5 @@ =end module FlatApi - VERSION = "0.1.2" + VERSION = "0.2.0" end diff --git a/spec/api/account_api_spec.rb b/spec/api/account_api_spec.rb index 18afa9d..69751f4 100644 --- a/spec/api/account_api_spec.rb +++ b/spec/api/account_api_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/api/class_api_spec.rb b/spec/api/class_api_spec.rb index 20bb904..513f68c 100644 --- a/spec/api/class_api_spec.rb +++ b/spec/api/class_api_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/api/collection_api_spec.rb b/spec/api/collection_api_spec.rb new file mode 100644 index 0000000..b4714aa --- /dev/null +++ b/spec/api/collection_api_spec.rb @@ -0,0 +1,159 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' + +# Unit tests for FlatApi::CollectionApi +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'CollectionApi' do + before do + # run before each test + @instance = FlatApi::CollectionApi.new + end + + after do + # run after each test + end + + describe 'test an instance of CollectionApi' do + it 'should create an instance of CollectionApi' do + expect(@instance).to be_instance_of(FlatApi::CollectionApi) + end + end + + # unit tests for add_score_to_collection + # Add a score to the collection + # 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. + # @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 + # @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`). + # @param [Hash] opts the optional parameters + # @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. + # @return [ScoreDetails] + describe 'add_score_to_collection test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for create_collection + # Create a new collection + # This method will create a new collection and add it to your `root` collection. + # @param body + # @param [Hash] opts the optional parameters + # @return [Collection] + describe 'create_collection test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_collection + # Delete the collection + # This method will schedule the deletion of the collection. Until deleted, the collection will be available in the `trash`. + # @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 + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_collection test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_score_from_collection + # Delete a score from the collection + # 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. + # @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 + # @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`). + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_score_from_collection test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for edit_collection + # Update a collection's metadata + # + # @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 + # @param [Hash] opts the optional parameters + # @option opts [CollectionModification] :body + # @return [Collection] + describe 'edit_collection test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_collection + # Get collection details + # + # @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 + # @param [Hash] opts the optional parameters + # @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. + # @return [Collection] + describe 'get_collection test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for list_collection_scores + # List the scores contained in a collection + # Use this method to list the scores contained in a collection. If no sort option is provided, the scores are sorted by `modificationDate` `desc`. + # @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 + # @param [Hash] opts the optional parameters + # @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. + # @option opts [String] :sort Sort + # @option opts [String] :direction Sort direction + # @option opts [Integer] :limit This is the maximum number of objects that may be returned + # @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. + # @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. + # @return [Array] + describe 'list_collection_scores test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for list_collections + # List the collections + # 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`. + # @param [Hash] opts the optional parameters + # @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`. + # @option opts [String] :sort Sort + # @option opts [String] :direction Sort direction + # @option opts [Integer] :limit This is the maximum number of objects that may be returned + # @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. + # @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. + # @return [Array] + describe 'list_collections test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for untrash_collection + # Untrash a collection + # This method will restore the collection by removing it from the `trash` and add it back to the `root` collection. + # @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 + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'untrash_collection test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/spec/api/group_api_spec.rb b/spec/api/group_api_spec.rb index 17c2da4..40cdfa1 100644 --- a/spec/api/group_api_spec.rb +++ b/spec/api/group_api_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/api/organization_api_spec.rb b/spec/api/organization_api_spec.rb index eb33325..dd0e9ca 100644 --- a/spec/api/organization_api_spec.rb +++ b/spec/api/organization_api_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/api/score_api_spec.rb b/spec/api/score_api_spec.rb index 2343ebb..00ef3e7 100644 --- a/spec/api/score_api_spec.rb +++ b/spec/api/score_api_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end @@ -34,11 +34,11 @@ # unit tests for add_score_collaborator # Add a new collaborator - # Share a score with a single user or a group. This API call allows to add, invite and update the collaborators of a document. - To add an existing Flat user to the document, specify its unique identifier in the `user` property. - To invite an external user to the document, specify its email in the `userEmail` property. - To add a Flat group to the document, specify its unique identifier in the `group` property. - To update an existing collaborator, process the same request with different rights. + # Share a score with a single user or a group. This API call allows to add, invite and update the collaborators of a resource. - To add an existing Flat user to the resource, specify its unique identifier in the `user` property. - To invite an external user to the resource, specify its email in the `userEmail` property. - To add a Flat group to the resource, specify its unique identifier in the `group` property. - To update an existing collaborator, process the same request with different rights. # @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`). # @param body # @param [Hash] opts the optional parameters - # @return [ScoreCollaborator] + # @return [ResourceCollaborator] describe 'add_score_collaborator test' do it "should work" do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers @@ -60,7 +60,7 @@ # unit tests for create_score # Create a new score - # Use this API method to **create a new music score in the current User account**. You will need a MusicXML 3 (`vnd.recordare.musicxml` or `vnd.recordare.musicxml+xml`) or a MIDI (`audio/midi`) file to create the new Flat document. This API call will automatically create the first revision of the document, the score can be modified by the using our web application or by uploading a new revision of this file (`POST /v2/scores/{score}/revisions/{revision}`). The currently authenticated user will be granted owner of the file and will be able to add other collaborators (users and groups). + # Use this API method to **create a new music score in the current User account**. You will need a MusicXML 3 (`vnd.recordare.musicxml` or `vnd.recordare.musicxml+xml`) or a MIDI (`audio/midi`) file to create the new Flat document. This API call will automatically create the first revision of the document, the score can be modified by the using our web application or by uploading a new revision of this file (`POST /v2/scores/{score}/revisions/{revision}`). The currently authenticated user will be granted owner of the file and will be able to add other collaborators (users and groups). If no `collection` is specified, the API will create the score in the most appropriate collection. This can be the `root` collection or a different collection based on the user's settings or API authentication method. If a `collection` is specified and this one has more public privacy settings than the score (e.g. `public` vs `private` for the score), the privacy settings of the created score will be adjusted to the collection ones. You can check the adjusted privacy settings in the returned score `privacy`, and optionally adjust these settings if needed using `PUT /scores/{score}`. # @param body # @param [Hash] opts the optional parameters # @return [ScoreDetails] @@ -85,7 +85,7 @@ # unit tests for delete_score # Delete a score - # This API call will schedule the deletion of the score, its revisions, and whole history. The user calling this API method must have the `aclAdmin` rights on this document to process this action. The score won't be accessible anymore after calling this method and the user's quota will directly be updated. + # This method can be used by the owner/admin (`aclAdmin` rights) of a score as well as regular collaborators. When called by an owner/admin, it will schedule the deletion of the score, its revisions, and complete history. The score won't be accessible anymore after calling this method and the user's quota will directly be updated. When called by a regular collaborator (`aclRead` / `aclWrite`), the score will be unshared (i.e. removed from the account & own collections). # @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`). # @param [Hash] opts the optional parameters # @return [nil] @@ -101,7 +101,7 @@ # @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`). # @param comment Unique identifier of a sheet music comment # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [nil] describe 'delete_score_comment test' do it "should work" do @@ -124,7 +124,7 @@ # unit tests for edit_score # Edit a score's metadata - # This API method allows you to change the metadata of a score document (e.g. its `title` or `privacy`), all the properties are optional. To edit the file itself, create a new revision using the appropriate method (`POST /v2/scores/{score}/revisions/{revision}`). + # This API method allows you to change the metadata of a score document (e.g. its `title` or `privacy`), all the properties are optional. To edit the file itself, create a new revision using the appropriate method (`POST /v2/scores/{score}/revisions/{revision}`). When editing the `title` of the score, the API metadata are updated directly when calling this method, unlike the data itself. The title in the score data will be \"lazy\" updated at the next score save with the editor or our internal save. # @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`). # @param [Hash] opts the optional parameters # @option opts [ScoreModification] :body @@ -141,7 +141,7 @@ # @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`). # @param body # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [ScoreDetails] describe 'fork_score test' do it "should work" do @@ -180,7 +180,7 @@ # Get the details of a score identified by the `score` parameter in the URL. The currently authenticated user must have at least a read access to the document to use this API call. # @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`). # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [ScoreDetails] describe 'get_score test' do it "should work" do @@ -194,8 +194,8 @@ # @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`). # @param collaborator Unique identifier of a **collaborator permission**, or unique identifier of a **User**, or unique identifier of a **Group** # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. - # @return [ScoreCollaborator] + # @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. + # @return [ResourceCollaborator] describe 'get_score_collaborator test' do it "should work" do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers @@ -207,8 +207,8 @@ # This API call will list the different collaborators of a score and their rights on the document. The returned list will at least contain the owner of the document. Collaborators can be a single user (the object `user` will be populated) or a group (the object `group` will be populated). # @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`). # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. - # @return [Array] + # @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. + # @return [Array] describe 'get_score_collaborators test' do it "should work" do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers @@ -220,7 +220,10 @@ # This method lists the different comments added on a music score (documents and inline) sorted by their post dates. # @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`). # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. + # @option opts [String] :type Filter the comments by type + # @option opts [String] :sort Sort + # @option opts [String] :direction Sort direction # @return [Array] describe 'get_score_comments test' do it "should work" do @@ -234,7 +237,7 @@ # @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`). # @param revision Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [ScoreRevision] describe 'get_score_revision test' do it "should work" do @@ -249,9 +252,9 @@ # @param revision Unique identifier of a score revision. You can use `last` to fetch the information related to the last version created. # @param format The format of the file you will retrieve # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. - # @option opts [BOOLEAN] :only_cached Only return files already generated and cached in Flat's production cache. If the file is not availabe, a 404 will be returned + # @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. # @option opts [String] :parts An optional a set of parts to be exported. This parameter must be specified with a list of integers. For example \"1,2,5\". + # @option opts [BOOLEAN] :only_cached Only return files already generated and cached in Flat's production cache. If the file is not availabe, a 404 will be returned # @return [String] describe 'get_score_revision_data test' do it "should work" do @@ -264,7 +267,7 @@ # When creating a score or saving a new version of a score, a revision is created in our storage. This method allows you to list all of them, sorted by last modification. Depending the plan of the account, this list can be trunked to the few last revisions. # @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`). # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [Array] describe 'get_score_revisions test' do it "should work" do @@ -290,7 +293,7 @@ # @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`). # @param track Unique identifier of a score audio track # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [ScoreTrack] describe 'get_score_track test' do it "should work" do @@ -300,7 +303,7 @@ # unit tests for get_user_scores # List user's scores - # Get the list of scores owned by the User + # Get the list of public scores owned by a User. **DEPRECATED**: Please note that the current behavior will be deprecrated on **2019-01-01**. This method will no longer list private and shared scores, but only public scores of a Flat account. If you want to access to private scores, please use the [Collections API](#tag/Collection) instead. # @param user Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user. # @param [Hash] opts the optional parameters # @option opts [String] :parent Filter the score forked from the score id `parent` @@ -316,7 +319,7 @@ # # @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`). # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [Array] describe 'list_score_tracks test' do it "should work" do @@ -330,7 +333,7 @@ # @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`). # @param comment Unique identifier of a sheet music comment # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [nil] describe 'mark_score_comment_resolved test' do it "should work" do @@ -344,7 +347,7 @@ # @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`). # @param comment Unique identifier of a sheet music comment # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [nil] describe 'mark_score_comment_unresolved test' do it "should work" do @@ -358,7 +361,7 @@ # @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`). # @param body # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [ScoreComment] describe 'post_score_comment test' do it "should work" do @@ -379,6 +382,18 @@ end end + # unit tests for untrash_score + # Untrash a score + # This method will remove the score from the `trash` collection and from the deletion queue, and add it back to the original collections. + # @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`). + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'untrash_score test' do + it "should work" do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + # unit tests for update_score_comment # Update an existing comment # @@ -386,7 +401,7 @@ # @param comment Unique identifier of a sheet music comment # @param body # @param [Hash] opts the optional parameters - # @option opts [String] :sharing_key This sharing key must be specified to access to a score with a `privacy` mode set to `privateLink` and the current user is not a collaborator of the document. + # @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. # @return [ScoreComment] describe 'update_score_comment test' do it "should work" do diff --git a/spec/api/user_api_spec.rb b/spec/api/user_api_spec.rb index 178edf0..672dfb3 100644 --- a/spec/api/user_api_spec.rb +++ b/spec/api/user_api_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end @@ -59,7 +59,7 @@ # unit tests for get_user_scores # List user's scores - # Get the list of scores owned by the User + # Get the list of public scores owned by a User. **DEPRECATED**: Please note that the current behavior will be deprecrated on **2019-01-01**. This method will no longer list private and shared scores, but only public scores of a Flat account. If you want to access to private scores, please use the [Collections API](#tag/Collection) instead. # @param user Unique identifier of a Flat user. If you authenticated, you can use `me` to refer to the current user. # @param [Hash] opts the optional parameters # @option opts [String] :parent Filter the score forked from the score id `parent` diff --git a/spec/api_client_spec.rb b/spec/api_client_spec.rb index fb5d10c..75a5529 100644 --- a/spec/api_client_spec.rb +++ b/spec/api_client_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/configuration_spec.rb b/spec/configuration_spec.rb index a018080..7a526b2 100644 --- a/spec/configuration_spec.rb +++ b/spec/configuration_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/assignment_copy_spec.rb b/spec/models/assignment_copy_spec.rb index 8a88fa7..caa467f 100644 --- a/spec/models/assignment_copy_spec.rb +++ b/spec/models/assignment_copy_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/assignment_creation_spec.rb b/spec/models/assignment_creation_spec.rb index 3a8a7fe..488d6dd 100644 --- a/spec/models/assignment_creation_spec.rb +++ b/spec/models/assignment_creation_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/assignment_spec.rb b/spec/models/assignment_spec.rb index 98b470f..7ef2c60 100644 --- a/spec/models/assignment_spec.rb +++ b/spec/models/assignment_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/assignment_submission_spec.rb b/spec/models/assignment_submission_spec.rb index e8286e4..127347b 100644 --- a/spec/models/assignment_submission_spec.rb +++ b/spec/models/assignment_submission_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/assignment_submission_update_spec.rb b/spec/models/assignment_submission_update_spec.rb index 8a68da4..39066b5 100644 --- a/spec/models/assignment_submission_update_spec.rb +++ b/spec/models/assignment_submission_update_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/class_attachment_creation_spec.rb b/spec/models/class_attachment_creation_spec.rb index b5cdd1c..8dff98a 100644 --- a/spec/models/class_attachment_creation_spec.rb +++ b/spec/models/class_attachment_creation_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/class_creation_spec.rb b/spec/models/class_creation_spec.rb index 3fc15fa..855bafd 100644 --- a/spec/models/class_creation_spec.rb +++ b/spec/models/class_creation_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/class_details_canvas_spec.rb b/spec/models/class_details_canvas_spec.rb index 337b87a..55f6374 100644 --- a/spec/models/class_details_canvas_spec.rb +++ b/spec/models/class_details_canvas_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/class_details_clever_spec.rb b/spec/models/class_details_clever_spec.rb index 0dccd11..096264a 100644 --- a/spec/models/class_details_clever_spec.rb +++ b/spec/models/class_details_clever_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/class_details_google_classroom_spec.rb b/spec/models/class_details_google_classroom_spec.rb index 3f09a0e..9bbaae5 100644 --- a/spec/models/class_details_google_classroom_spec.rb +++ b/spec/models/class_details_google_classroom_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/class_details_google_drive_spec.rb b/spec/models/class_details_google_drive_spec.rb index 4c79de6..74e8555 100644 --- a/spec/models/class_details_google_drive_spec.rb +++ b/spec/models/class_details_google_drive_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/class_details_lti_spec.rb b/spec/models/class_details_lti_spec.rb index 748593a..7144995 100644 --- a/spec/models/class_details_lti_spec.rb +++ b/spec/models/class_details_lti_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/class_details_spec.rb b/spec/models/class_details_spec.rb index 2c94e77..992810d 100644 --- a/spec/models/class_details_spec.rb +++ b/spec/models/class_details_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/class_roles_spec.rb b/spec/models/class_roles_spec.rb index 21a21e3..2edec0e 100644 --- a/spec/models/class_roles_spec.rb +++ b/spec/models/class_roles_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/class_state_spec.rb b/spec/models/class_state_spec.rb index 9bae347..90d2297 100644 --- a/spec/models/class_state_spec.rb +++ b/spec/models/class_state_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/class_update_spec.rb b/spec/models/class_update_spec.rb index 24c007f..bf209d1 100644 --- a/spec/models/class_update_spec.rb +++ b/spec/models/class_update_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/collection_capabilities_spec.rb b/spec/models/collection_capabilities_spec.rb new file mode 100644 index 0000000..7155910 --- /dev/null +++ b/spec/models/collection_capabilities_spec.rb @@ -0,0 +1,66 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for FlatApi::CollectionCapabilities +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'CollectionCapabilities' do + before do + # run before each test + @instance = FlatApi::CollectionCapabilities.new + end + + after do + # run after each test + end + + describe 'test an instance of CollectionCapabilities' do + it 'should create an instance of CollectionCapabilities' do + expect(@instance).to be_instance_of(FlatApi::CollectionCapabilities) + end + end + describe 'test attribute "can_edit"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "can_share"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "can_delete"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "can_add_scores"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "can_delete_scores"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end + diff --git a/spec/models/collection_creation_spec.rb b/spec/models/collection_creation_spec.rb new file mode 100644 index 0000000..e6142e7 --- /dev/null +++ b/spec/models/collection_creation_spec.rb @@ -0,0 +1,42 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for FlatApi::CollectionCreation +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'CollectionCreation' do + before do + # run before each test + @instance = FlatApi::CollectionCreation.new + end + + after do + # run after each test + end + + describe 'test an instance of CollectionCreation' do + it 'should create an instance of CollectionCreation' do + expect(@instance).to be_instance_of(FlatApi::CollectionCreation) + end + end + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end + diff --git a/spec/models/collection_modification_spec.rb b/spec/models/collection_modification_spec.rb new file mode 100644 index 0000000..bd8dd94 --- /dev/null +++ b/spec/models/collection_modification_spec.rb @@ -0,0 +1,42 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for FlatApi::CollectionModification +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'CollectionModification' do + before do + # run before each test + @instance = FlatApi::CollectionModification.new + end + + after do + # run after each test + end + + describe 'test an instance of CollectionModification' do + it 'should create an instance of CollectionModification' do + expect(@instance).to be_instance_of(FlatApi::CollectionModification) + end + end + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end + diff --git a/spec/models/collection_privacy_spec.rb b/spec/models/collection_privacy_spec.rb new file mode 100644 index 0000000..071bccc --- /dev/null +++ b/spec/models/collection_privacy_spec.rb @@ -0,0 +1,36 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for FlatApi::CollectionPrivacy +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'CollectionPrivacy' do + before do + # run before each test + @instance = FlatApi::CollectionPrivacy.new + end + + after do + # run after each test + end + + describe 'test an instance of CollectionPrivacy' do + it 'should create an instance of CollectionPrivacy' do + expect(@instance).to be_instance_of(FlatApi::CollectionPrivacy) + end + end +end + diff --git a/spec/models/collection_spec.rb b/spec/models/collection_spec.rb new file mode 100644 index 0000000..0189f40 --- /dev/null +++ b/spec/models/collection_spec.rb @@ -0,0 +1,102 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for FlatApi::Collection +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'Collection' do + before do + # run before each test + @instance = FlatApi::Collection.new + end + + after do + # run after each test + end + + describe 'test an instance of Collection' do + it 'should create an instance of Collection' do + expect(@instance).to be_instance_of(FlatApi::Collection) + end + end + describe 'test attribute "id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "html_url"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "type"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "privacy"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "sharing_key"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "app"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "user"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "rights"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "collaborators"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "capabilities"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end + diff --git a/spec/models/collection_title_spec.rb b/spec/models/collection_title_spec.rb new file mode 100644 index 0000000..528ffc1 --- /dev/null +++ b/spec/models/collection_title_spec.rb @@ -0,0 +1,36 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for FlatApi::CollectionTitle +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'CollectionTitle' do + before do + # run before each test + @instance = FlatApi::CollectionTitle.new + end + + after do + # run after each test + end + + describe 'test an instance of CollectionTitle' do + it 'should create an instance of CollectionTitle' do + expect(@instance).to be_instance_of(FlatApi::CollectionTitle) + end + end +end + diff --git a/spec/models/collection_type_spec.rb b/spec/models/collection_type_spec.rb new file mode 100644 index 0000000..f9edf6c --- /dev/null +++ b/spec/models/collection_type_spec.rb @@ -0,0 +1,36 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for FlatApi::CollectionType +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'CollectionType' do + before do + # run before each test + @instance = FlatApi::CollectionType.new + end + + after do + # run after each test + end + + describe 'test an instance of CollectionType' do + it 'should create an instance of CollectionType' do + expect(@instance).to be_instance_of(FlatApi::CollectionType) + end + end +end + diff --git a/spec/models/flat_error_response_spec.rb b/spec/models/flat_error_response_spec.rb index 7334d29..b764d2e 100644 --- a/spec/models/flat_error_response_spec.rb +++ b/spec/models/flat_error_response_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/flat_locales_spec.rb b/spec/models/flat_locales_spec.rb index 5d8ce60..9930eba 100644 --- a/spec/models/flat_locales_spec.rb +++ b/spec/models/flat_locales_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/google_classroom_coursework_spec.rb b/spec/models/google_classroom_coursework_spec.rb index f3be1df..592ac8d 100644 --- a/spec/models/google_classroom_coursework_spec.rb +++ b/spec/models/google_classroom_coursework_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/google_classroom_submission_spec.rb b/spec/models/google_classroom_submission_spec.rb index 9d8007c..56eca8c 100644 --- a/spec/models/google_classroom_submission_spec.rb +++ b/spec/models/google_classroom_submission_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/group_details_spec.rb b/spec/models/group_details_spec.rb index 287fbe7..5138bf9 100644 --- a/spec/models/group_details_spec.rb +++ b/spec/models/group_details_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/group_spec.rb b/spec/models/group_spec.rb index de4f0bf..43df88c 100644 --- a/spec/models/group_spec.rb +++ b/spec/models/group_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/group_type_spec.rb b/spec/models/group_type_spec.rb index 289147d..77ba290 100644 --- a/spec/models/group_type_spec.rb +++ b/spec/models/group_type_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/license_mode_spec.rb b/spec/models/license_mode_spec.rb index 9da0781..b32017f 100644 --- a/spec/models/license_mode_spec.rb +++ b/spec/models/license_mode_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/license_sources_spec.rb b/spec/models/license_sources_spec.rb index 2f0db84..b3fd108 100644 --- a/spec/models/license_sources_spec.rb +++ b/spec/models/license_sources_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/lms_name_spec.rb b/spec/models/lms_name_spec.rb index 77c8506..48f1494 100644 --- a/spec/models/lms_name_spec.rb +++ b/spec/models/lms_name_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/lti_credentials_creation_spec.rb b/spec/models/lti_credentials_creation_spec.rb index f115fed..c1c9aef 100644 --- a/spec/models/lti_credentials_creation_spec.rb +++ b/spec/models/lti_credentials_creation_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/lti_credentials_spec.rb b/spec/models/lti_credentials_spec.rb index c5a8652..392810a 100644 --- a/spec/models/lti_credentials_spec.rb +++ b/spec/models/lti_credentials_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/media_attachment_spec.rb b/spec/models/media_attachment_spec.rb index 9082217..0ea0a5d 100644 --- a/spec/models/media_attachment_spec.rb +++ b/spec/models/media_attachment_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/media_score_sharing_mode_spec.rb b/spec/models/media_score_sharing_mode_spec.rb index 7c73704..7019348 100644 --- a/spec/models/media_score_sharing_mode_spec.rb +++ b/spec/models/media_score_sharing_mode_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/organization_invitation_creation_spec.rb b/spec/models/organization_invitation_creation_spec.rb index 6e9c29b..50d5322 100644 --- a/spec/models/organization_invitation_creation_spec.rb +++ b/spec/models/organization_invitation_creation_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/organization_invitation_spec.rb b/spec/models/organization_invitation_spec.rb index 3886219..ce8921d 100644 --- a/spec/models/organization_invitation_spec.rb +++ b/spec/models/organization_invitation_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/organization_roles_spec.rb b/spec/models/organization_roles_spec.rb index 9af6c97..a78d376 100644 --- a/spec/models/organization_roles_spec.rb +++ b/spec/models/organization_roles_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_collaborator_creation_spec.rb b/spec/models/resource_collaborator_creation_spec.rb similarity index 83% rename from spec/models/score_collaborator_creation_spec.rb rename to spec/models/resource_collaborator_creation_spec.rb index 2fada75..ed42033 100644 --- a/spec/models/score_collaborator_creation_spec.rb +++ b/spec/models/resource_collaborator_creation_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end @@ -14,22 +14,22 @@ require 'json' require 'date' -# Unit tests for FlatApi::ScoreCollaboratorCreation +# Unit tests for FlatApi::ResourceCollaboratorCreation # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) # Please update as you see appropriate -describe 'ScoreCollaboratorCreation' do +describe 'ResourceCollaboratorCreation' do before do # run before each test - @instance = FlatApi::ScoreCollaboratorCreation.new + @instance = FlatApi::ResourceCollaboratorCreation.new end after do # run after each test end - describe 'test an instance of ScoreCollaboratorCreation' do - it 'should create an instance of ScoreCollaboratorCreation' do - expect(@instance).to be_instance_of(FlatApi::ScoreCollaboratorCreation) + describe 'test an instance of ResourceCollaboratorCreation' do + it 'should create an instance of ResourceCollaboratorCreation' do + expect(@instance).to be_instance_of(FlatApi::ResourceCollaboratorCreation) end end describe 'test attribute "user"' do @@ -50,6 +50,12 @@ end end + describe 'test attribute "user_token"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + describe 'test attribute "acl_read"' do it 'should work' do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers diff --git a/spec/models/score_collaborator_spec.rb b/spec/models/resource_collaborator_spec.rb similarity index 85% rename from spec/models/score_collaborator_spec.rb rename to spec/models/resource_collaborator_spec.rb index dcd199d..1f91b35 100644 --- a/spec/models/score_collaborator_spec.rb +++ b/spec/models/resource_collaborator_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end @@ -14,67 +14,73 @@ require 'json' require 'date' -# Unit tests for FlatApi::ScoreCollaborator +# Unit tests for FlatApi::ResourceCollaborator # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) # Please update as you see appropriate -describe 'ScoreCollaborator' do +describe 'ResourceCollaborator' do before do # run before each test - @instance = FlatApi::ScoreCollaborator.new + @instance = FlatApi::ResourceCollaborator.new end after do # run after each test end - describe 'test an instance of ScoreCollaborator' do - it 'should create an instance of ScoreCollaborator' do - expect(@instance).to be_instance_of(FlatApi::ScoreCollaborator) + describe 'test an instance of ResourceCollaborator' do + it 'should create an instance of ResourceCollaborator' do + expect(@instance).to be_instance_of(FlatApi::ResourceCollaborator) end end - describe 'test attribute "id"' do + describe 'test attribute "acl_read"' do it 'should work' do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers end end - describe 'test attribute "score"' do + describe 'test attribute "acl_write"' do it 'should work' do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers end end - describe 'test attribute "user"' do + describe 'test attribute "acl_admin"' do it 'should work' do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers end end - describe 'test attribute "group"' do + describe 'test attribute "id"' do it 'should work' do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers end end - describe 'test attribute "user_email"' do + describe 'test attribute "score"' do it 'should work' do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers end end - describe 'test attribute "acl_read"' do + describe 'test attribute "collection"' do it 'should work' do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers end end - describe 'test attribute "acl_write"' do + describe 'test attribute "user"' do it 'should work' do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers end end - describe 'test attribute "acl_admin"' do + describe 'test attribute "group"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "user_email"' do it 'should work' do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers end diff --git a/spec/models/score_rights_spec.rb b/spec/models/resource_rights_spec.rb similarity index 81% rename from spec/models/score_rights_spec.rb rename to spec/models/resource_rights_spec.rb index da0506d..0e27491 100644 --- a/spec/models/score_rights_spec.rb +++ b/spec/models/resource_rights_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end @@ -14,24 +14,30 @@ require 'json' require 'date' -# Unit tests for FlatApi::ScoreRights +# Unit tests for FlatApi::ResourceRights # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) # Please update as you see appropriate -describe 'ScoreRights' do +describe 'ResourceRights' do before do # run before each test - @instance = FlatApi::ScoreRights.new + @instance = FlatApi::ResourceRights.new end after do # run after each test end - describe 'test an instance of ScoreRights' do - it 'should create an instance of ScoreRights' do - expect(@instance).to be_instance_of(FlatApi::ScoreRights) + describe 'test an instance of ResourceRights' do + it 'should create an instance of ResourceRights' do + expect(@instance).to be_instance_of(FlatApi::ResourceRights) end end + describe 'test attribute "acl_read"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + describe 'test attribute "acl_write"' do it 'should work' do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers diff --git a/spec/models/resource_sharing_key_spec.rb b/spec/models/resource_sharing_key_spec.rb new file mode 100644 index 0000000..f3f1d41 --- /dev/null +++ b/spec/models/resource_sharing_key_spec.rb @@ -0,0 +1,36 @@ +=begin +#Flat API + +#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 or MIDI 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 interoduction](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) + +OpenAPI spec version: 2.6.0 +Contact: developers@flat.io +Generated by: https://github.com/swagger-api/swagger-codegen.git +Swagger Codegen version: 2.4.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for FlatApi::ResourceSharingKey +# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen) +# Please update as you see appropriate +describe 'ResourceSharingKey' do + before do + # run before each test + @instance = FlatApi::ResourceSharingKey.new + end + + after do + # run after each test + end + + describe 'test an instance of ResourceSharingKey' do + it 'should create an instance of ResourceSharingKey' do + expect(@instance).to be_instance_of(FlatApi::ResourceSharingKey) + end + end +end + diff --git a/spec/models/score_comment_context_spec.rb b/spec/models/score_comment_context_spec.rb index a115acb..a87b709 100644 --- a/spec/models/score_comment_context_spec.rb +++ b/spec/models/score_comment_context_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_comment_creation_spec.rb b/spec/models/score_comment_creation_spec.rb index 7ab67e7..2018e1d 100644 --- a/spec/models/score_comment_creation_spec.rb +++ b/spec/models/score_comment_creation_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_comment_spec.rb b/spec/models/score_comment_spec.rb index ac25b53..218524b 100644 --- a/spec/models/score_comment_spec.rb +++ b/spec/models/score_comment_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_comment_update_spec.rb b/spec/models/score_comment_update_spec.rb index 2b39efb..423fe88 100644 --- a/spec/models/score_comment_update_spec.rb +++ b/spec/models/score_comment_update_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_comments_counts_spec.rb b/spec/models/score_comments_counts_spec.rb index f1a9443..87728e2 100644 --- a/spec/models/score_comments_counts_spec.rb +++ b/spec/models/score_comments_counts_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_creation_spec.rb b/spec/models/score_creation_spec.rb index b6631c2..9c91fc6 100644 --- a/spec/models/score_creation_spec.rb +++ b/spec/models/score_creation_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end @@ -62,6 +62,12 @@ end end + describe 'test attribute "collection"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + describe 'test attribute "google_drive_folder"' do it 'should work' do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers diff --git a/spec/models/score_creation_type_spec.rb b/spec/models/score_creation_type_spec.rb index fe3e9e2..e1074f7 100644 --- a/spec/models/score_creation_type_spec.rb +++ b/spec/models/score_creation_type_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_data_encoding_spec.rb b/spec/models/score_data_encoding_spec.rb index cbf23e5..f1ae600 100644 --- a/spec/models/score_data_encoding_spec.rb +++ b/spec/models/score_data_encoding_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_data_spec.rb b/spec/models/score_data_spec.rb index 5ec7383..d93761f 100644 --- a/spec/models/score_data_spec.rb +++ b/spec/models/score_data_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_details_spec.rb b/spec/models/score_details_spec.rb index 7152100..da7c443 100644 --- a/spec/models/score_details_spec.rb +++ b/spec/models/score_details_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_fork_spec.rb b/spec/models/score_fork_spec.rb index 3d07656..f1beacc 100644 --- a/spec/models/score_fork_spec.rb +++ b/spec/models/score_fork_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end @@ -32,5 +32,11 @@ expect(@instance).to be_instance_of(FlatApi::ScoreFork) end end + describe 'test attribute "collection"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + end diff --git a/spec/models/score_license_spec.rb b/spec/models/score_license_spec.rb index b2c4437..eb7cffe 100644 --- a/spec/models/score_license_spec.rb +++ b/spec/models/score_license_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_likes_counts_spec.rb b/spec/models/score_likes_counts_spec.rb index 23637f9..2d0be7e 100644 --- a/spec/models/score_likes_counts_spec.rb +++ b/spec/models/score_likes_counts_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_modification_spec.rb b/spec/models/score_modification_spec.rb index 8dccedf..c0f3999 100644 --- a/spec/models/score_modification_spec.rb +++ b/spec/models/score_modification_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end @@ -32,6 +32,12 @@ expect(@instance).to be_instance_of(FlatApi::ScoreModification) end end + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + describe 'test attribute "privacy"' do it 'should work' do # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers diff --git a/spec/models/score_privacy_spec.rb b/spec/models/score_privacy_spec.rb index 78b424f..7aba541 100644 --- a/spec/models/score_privacy_spec.rb +++ b/spec/models/score_privacy_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_revision_creation_spec.rb b/spec/models/score_revision_creation_spec.rb index e2a8c14..d797082 100644 --- a/spec/models/score_revision_creation_spec.rb +++ b/spec/models/score_revision_creation_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_revision_spec.rb b/spec/models/score_revision_spec.rb index b70b469..595e72d 100644 --- a/spec/models/score_revision_spec.rb +++ b/spec/models/score_revision_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_revision_statistics_spec.rb b/spec/models/score_revision_statistics_spec.rb index e930609..393b283 100644 --- a/spec/models/score_revision_statistics_spec.rb +++ b/spec/models/score_revision_statistics_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_source_spec.rb b/spec/models/score_source_spec.rb index d93fd2d..9cb41f6 100644 --- a/spec/models/score_source_spec.rb +++ b/spec/models/score_source_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_summary_spec.rb b/spec/models/score_summary_spec.rb index 2d16251..b852ea3 100644 --- a/spec/models/score_summary_spec.rb +++ b/spec/models/score_summary_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_track_creation_spec.rb b/spec/models/score_track_creation_spec.rb index 87516ee..e8d2197 100644 --- a/spec/models/score_track_creation_spec.rb +++ b/spec/models/score_track_creation_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_track_point_spec.rb b/spec/models/score_track_point_spec.rb index 3a6a059..659f7a0 100644 --- a/spec/models/score_track_point_spec.rb +++ b/spec/models/score_track_point_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_track_spec.rb b/spec/models/score_track_spec.rb index d854849..ad2362e 100644 --- a/spec/models/score_track_spec.rb +++ b/spec/models/score_track_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_track_state_spec.rb b/spec/models/score_track_state_spec.rb index 5872193..8b6b99c 100644 --- a/spec/models/score_track_state_spec.rb +++ b/spec/models/score_track_state_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_track_type_spec.rb b/spec/models/score_track_type_spec.rb index 97153dd..9338986 100644 --- a/spec/models/score_track_type_spec.rb +++ b/spec/models/score_track_type_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_track_update_spec.rb b/spec/models/score_track_update_spec.rb index ab3f709..6ca77ab 100644 --- a/spec/models/score_track_update_spec.rb +++ b/spec/models/score_track_update_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/score_views_counts_spec.rb b/spec/models/score_views_counts_spec.rb index 86b675c..f396f6d 100644 --- a/spec/models/score_views_counts_spec.rb +++ b/spec/models/score_views_counts_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/user_admin_update_spec.rb b/spec/models/user_admin_update_spec.rb index 8a92115..691fdf4 100644 --- a/spec/models/user_admin_update_spec.rb +++ b/spec/models/user_admin_update_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/user_basics_spec.rb b/spec/models/user_basics_spec.rb index 98ee2f3..88502b3 100644 --- a/spec/models/user_basics_spec.rb +++ b/spec/models/user_basics_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/user_creation_spec.rb b/spec/models/user_creation_spec.rb index 575adbf..26818f3 100644 --- a/spec/models/user_creation_spec.rb +++ b/spec/models/user_creation_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/user_details_admin_license_spec.rb b/spec/models/user_details_admin_license_spec.rb index ea8d771..2f299a9 100644 --- a/spec/models/user_details_admin_license_spec.rb +++ b/spec/models/user_details_admin_license_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/user_details_admin_spec.rb b/spec/models/user_details_admin_spec.rb index b4411fe..88923cb 100644 --- a/spec/models/user_details_admin_spec.rb +++ b/spec/models/user_details_admin_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/user_details_spec.rb b/spec/models/user_details_spec.rb index 1c06540..2d45a73 100644 --- a/spec/models/user_details_spec.rb +++ b/spec/models/user_details_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/user_instruments_spec.rb b/spec/models/user_instruments_spec.rb index 555df97..f13fbde 100644 --- a/spec/models/user_instruments_spec.rb +++ b/spec/models/user_instruments_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/user_public_spec.rb b/spec/models/user_public_spec.rb index bf7ba95..6f9a3ae 100644 --- a/spec/models/user_public_spec.rb +++ b/spec/models/user_public_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/models/user_public_summary_spec.rb b/spec/models/user_public_summary_spec.rb index e51325f..f64100a 100644 --- a/spec/models/user_public_summary_spec.rb +++ b/spec/models/user_public_summary_spec.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index f9d3638..2de1877 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -3,10 +3,10 @@ #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 or MIDI 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 interoduction](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) -OpenAPI spec version: 2.5.0 +OpenAPI spec version: 2.6.0 Contact: developers@flat.io Generated by: https://github.com/swagger-api/swagger-codegen.git -Swagger Codegen version: 2.2.3-SNAPSHOT +Swagger Codegen version: 2.4.0-SNAPSHOT =end