flat_api 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6fea1dead831600b117241b809b2d90de9adb548
-  data.tar.gz: 6299f8de69bc2294f4e8e92febdb146c7d1a456d
+SHA256:
+  metadata.gz: 9a704ee84b9748ef7b2af270c65b126da180b094afcd2c3646f22456d58bdb98
+  data.tar.gz: 62cedf0446d8da6c1774b7b64a38b8cbff751bc7566e95f3b1a8c34364a88ee0
 SHA512:
-  metadata.gz: fd3b6d9e2dc242bb61bc8a50ea3537ac698c466a5f97a35b8de579ad7c43728bff6515ba866a936761694a8c7590ac1da89210aa7324c9697141f6e6f32491f4
-  data.tar.gz: 0b6d20d0ac833e84aae304320911d7cc701a2f59c4ebf6ac680f5036c551bc32e99bd157e41ef22f4b374ad196e79f74bfeb804ee772935172c79775e8534f14
+  metadata.gz: 102868229a28bb85e3a8885692f1c87861b229de6c7174c112753f88752c749ca922c0505f814135bb2b60746d39b03e6225bc0ab2ebbe124a0a99850a5fc8c6
+  data.tar.gz: 3f4d9708b651fe7c9c15abbc96ae8000e4db3e92db063cfaf423ce3ce783f4783e15f13826fb7027d9dc0e3d3464b20f352592e79b5974b7d0e7ac5728e8658a

data/CHANGELOG.md

@@ -1,17 +1,69 @@
 # Changelog
 
-## 0.2.0
+## [1.0.0](https://github.com/FlatIO/api-client-ruby/compare/v0.3.5...1.0.0) (2026-09-11)
 
-Spec version 2.6.0
+The first stable release. Regenerated against API specification 2.26.1, covering all 123 public
+operations. See [MIGRATION.md](MIGRATION.md) for the upgrade from 0.3.x.
 
-## 0.1.2
+### Features
 
-Spec version 2.5.2
+* Typed errors: an API failure raises `FlatNotFoundError`, `FlatAuthenticationError` and the rest
+  of the `FlatApi::FlatError` hierarchy, rather than one generic exception carrying a status code.
+* Retries with backoff. Flat returns HTTP 403 for rate limiting with the reset time in
+  `X-RateLimit-Reset`, so the retry decision reads the response body's `code` to tell a throttle
+  from a genuine authorization failure.
+* Pagination that follows the `Link` header cursor, which the specification does not declare.
+* OAuth2 token refresh.
 
-## 0.1.1
+### Breaking Changes
 
-Regenerate with swagger-api/swagger-codegen#b184fb1d9c to fix Enums `build_from_hash`
+* The HTTP layer is Faraday, not Typhoeus. Typhoeus needs libcurl; Faraday does not.
+* Requires Ruby 3.3 or later, matching the versions upstream still supports.
+* Models and operations are regenerated, so names follow the current specification.
 
-## 0.1.0
+## [0.3.5](https://github.com/FlatIO/api-client-ruby/compare/v0.3.4...v0.3.5) (2024-03-08)
 
-Initial release
+
+### Bug Fixes
+
+* bump version to 0.3.5, fix rubygem publish ([4910d77](https://github.com/FlatIO/api-client-ruby/commit/4910d77a49ef92dd5026ececb378cd73ca8d5e43))
+
+## [0.3.4](https://github.com/FlatIO/api-client-ruby/compare/v0.3.3...v0.3.4) (2024-03-08)
+
+
+### Bug Fixes
+
+* bump version to 0.3.4 ([ac5999b](https://github.com/FlatIO/api-client-ruby/commit/ac5999b686351ee88770bd9c1279fab09e8a161e))
+
+## [0.3.3](https://github.com/FlatIO/api-client-ruby/compare/v0.3.2...v0.3.3) (2024-03-08)
+
+
+### Bug Fixes
+
+* **gemspec:** only include lib/ to files list ([576cac9](https://github.com/FlatIO/api-client-ruby/commit/576cac92a848c7b3e4b712feb6429684ec3c16d2))
+
+## [0.3.2](https://github.com/FlatIO/api-client-ruby/compare/v0.3.1...v0.3.2) (2024-03-08)
+
+
+### Bug Fixes
+
+* **gh:** permission to write github packages ([a1979e2](https://github.com/FlatIO/api-client-ruby/commit/a1979e2a87bec830353b30355a531ea8c23075ed))
+
+## [0.3.1](https://github.com/FlatIO/api-client-ruby/compare/v0.3.0...v0.3.1) (2024-03-08)
+
+
+### Bug Fixes
+
+* bump version for rubygem release ([fd11d52](https://github.com/FlatIO/api-client-ruby/commit/fd11d5234f91e346c01dc233ee9343d4773aee7a))
+
+## [0.3.0](https://github.com/FlatIO/api-client-ruby/compare/v0.2.0...v0.3.0) (2024-03-08)
+
+
+### Features
+
+* update for API 2.20.0 ([30bf4d6](https://github.com/FlatIO/api-client-ruby/commit/30bf4d6b5f74a463beafcc8a4ec81388863a6c55))
+
+
+### Bug Fixes
+
+* min ruby version 3.0 ([d5fce26](https://github.com/FlatIO/api-client-ruby/commit/d5fce26465b4f9666a973c5542d0a5a7c6eb53a1))

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,271 +1,92 @@
-# Ruby Client for the Flat REST API
+# Flat API client for Ruby
 
-[![Build Status](https://travis-ci.org/FlatIO/api-client-ruby.svg?branch=master)](https://travis-ci.org/FlatIO/api-client-ruby)
-[![Rubygems](https://img.shields.io/gem/v/flat_api.svg)](https://rubygems.org/gems/flat_api)
+Official client for the [Flat REST API](https://flat.io/developers/docs/api/), generated from Flat's
+public OpenAPI specification and kept current automatically.
 
-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.
-
-You can find the API reference including code samples and our OpenAPI Specification at the following url: [https://flat.io/developers/api/reference](https://flat.io/developers/api/reference).
-
-To request some API credentials, please visit [https://flat.io/developers](https://flat.io/developers).
-
-This Ruby package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project.
-
-## Installation
-
-### Build a gem
-
-To build the Ruby code into a gem:
-
-```shell
-gem build flat_api.gemspec
+```sh
+gem install flat_api
 ```
 
-Then either install the gem locally:
+```ruby
+require 'flat_api'
 
-```shell
-gem install ./flat_api-0.2.0.gem
+client = FlatApi::FlatClient.new(access_token: 'YOUR_TOKEN')
+puts client.account.get_authenticated_user.username
 ```
-(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.2.0'
-
-### Install from Git
 
-If the Ruby gem is hosted at a git repository: https://github.com/FlatIO/api-client-ruby, then add the following in the Gemfile:
+Get a token in seconds with a [Personal Access Token](https://flat.io/developers/apps); it works
+exactly like an OAuth access token for your own account.
 
-    gem 'flat_api', :git => 'https://github.com/FlatIO/api-client-ruby.git'
+## What this client does for you
 
-### Include the Ruby code directly
+- **Typed errors.** Branch on the error, not the status code. Flat returns HTTP 403 for both rate
+  limiting and authorization failures, so status alone cannot tell them apart.
+- **Automatic retries.** Rate limits and server errors are retried with backoff. Flat sends no
+  `Retry-After`, so the client reads `X-RateLimit-Reset` instead.
+- **Automatic pagination.** Eight collection endpoints are cursor-paginated with the cursor in a
+  `Link` header. You get an iterator; you never touch a cursor.
+- **OAuth2 built in.** Authorization URLs, code exchange and transparent token refresh.
+- **Full type information**, so your editor and your coding assistant both know the API.
 
-Include the Ruby code directly using `-I` as follows:
+### Pagination
 
-```shell
-ruby -Ilib script.rb
-```
-
-## Getting Started
-
-Please follow the [installation](#installation) procedure and then run the following code:
 ```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'
+client.paginate(:list_collections, parent: 'user') do |collection|
+  puts collection.title
 end
+```
 
-api_instance = FlatApi::AccountApi.new
+`paginate` takes any operation: positional arguments are its path parameters, keywords its query
+parameters. It follows the cursor for you and stops at the last page.
 
+### Errors
+
+```ruby
 begin
-  #Get current user profile
-  result = api_instance.get_authenticated_user
-  p result
-rescue FlatApi::ApiError => e
-  puts "Exception when calling AccountApi->get_authenticated_user: #{e}"
+  # ...
+rescue FlatApi::FlatRateLimitError => e
+  puts "retry after #{e.reset}"
+rescue FlatApi::FlatNotFoundError
+  puts 'no such score'
 end
-
 ```
 
-## Documentation for API Endpoints
+### Asynchronous use
 
-All URIs are relative to *https://api.flat.io/v2*
+Synchronous only: async is not idiomatic in Ruby for this shape of client.
 
-Class | Method | HTTP request | Description
------------- | ------------- | ------------- | -------------
-*FlatApi::AccountApi* | [**get_authenticated_user**](docs/AccountApi.md#get_authenticated_user) | **GET** /me | Get current user profile
-*FlatApi::ClassApi* | [**activate_class**](docs/ClassApi.md#activate_class) | **POST** /classes/{class}/activate | Activate the class
-*FlatApi::ClassApi* | [**add_class_user**](docs/ClassApi.md#add_class_user) | **PUT** /classes/{class}/users/{user} | Add a user to the class
-*FlatApi::ClassApi* | [**archive_class**](docs/ClassApi.md#archive_class) | **POST** /classes/{class}/archive | Archive the class
-*FlatApi::ClassApi* | [**copy_assignment**](docs/ClassApi.md#copy_assignment) | **POST** /classes/{class}/assignments/{assignment}/copy | Copy an assignment
-*FlatApi::ClassApi* | [**create_assignment**](docs/ClassApi.md#create_assignment) | **POST** /classes/{class}/assignments | Assignment creation
-*FlatApi::ClassApi* | [**create_class**](docs/ClassApi.md#create_class) | **POST** /classes | Create a new class
-*FlatApi::ClassApi* | [**create_submission**](docs/ClassApi.md#create_submission) | **PUT** /classes/{class}/assignments/{assignment}/submissions | Create or edit a submission
-*FlatApi::ClassApi* | [**delete_class_user**](docs/ClassApi.md#delete_class_user) | **DELETE** /classes/{class}/users/{user} | Remove a user from the class
-*FlatApi::ClassApi* | [**edit_submission**](docs/ClassApi.md#edit_submission) | **PUT** /classes/{class}/assignments/{assignment}/submissions/{submission} | Edit a submission
-*FlatApi::ClassApi* | [**enroll_class**](docs/ClassApi.md#enroll_class) | **POST** /classes/enroll/{enrollmentCode} | Join a class
-*FlatApi::ClassApi* | [**get_class**](docs/ClassApi.md#get_class) | **GET** /classes/{class} | Get the details of a single class
-*FlatApi::ClassApi* | [**get_score_submissions**](docs/ClassApi.md#get_score_submissions) | **GET** /scores/{score}/submissions | List submissions related to the score
-*FlatApi::ClassApi* | [**get_submission**](docs/ClassApi.md#get_submission) | **GET** /classes/{class}/assignments/{assignment}/submissions/{submission} | Get a student submission
-*FlatApi::ClassApi* | [**get_submissions**](docs/ClassApi.md#get_submissions) | **GET** /classes/{class}/assignments/{assignment}/submissions | List the students' submissions
-*FlatApi::ClassApi* | [**list_assignments**](docs/ClassApi.md#list_assignments) | **GET** /classes/{class}/assignments | Assignments listing
-*FlatApi::ClassApi* | [**list_class_student_submissions**](docs/ClassApi.md#list_class_student_submissions) | **GET** /classes/{class}/students/{user}/submissions | List the submissions for a student
-*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
-*FlatApi::OrganizationApi* | [**create_lti_credentials**](docs/OrganizationApi.md#create_lti_credentials) | **POST** /organizations/lti/credentials | Create a new couple of LTI 1.x credentials
-*FlatApi::OrganizationApi* | [**create_organization_invitation**](docs/OrganizationApi.md#create_organization_invitation) | **POST** /organizations/invitations | Create a new invitation to join the organization
-*FlatApi::OrganizationApi* | [**create_organization_user**](docs/OrganizationApi.md#create_organization_user) | **POST** /organizations/users | Create a new user account
-*FlatApi::OrganizationApi* | [**list_lti_credentials**](docs/OrganizationApi.md#list_lti_credentials) | **GET** /organizations/lti/credentials | List LTI 1.x credentials
-*FlatApi::OrganizationApi* | [**list_organization_invitations**](docs/OrganizationApi.md#list_organization_invitations) | **GET** /organizations/invitations | List the organization invitations
-*FlatApi::OrganizationApi* | [**list_organization_users**](docs/OrganizationApi.md#list_organization_users) | **GET** /organizations/users | List the organization users
-*FlatApi::OrganizationApi* | [**remove_organization_invitation**](docs/OrganizationApi.md#remove_organization_invitation) | **DELETE** /organizations/invitations/{invitation} | Remove an organization invitation
-*FlatApi::OrganizationApi* | [**remove_organization_user**](docs/OrganizationApi.md#remove_organization_user) | **DELETE** /organizations/users/{user} | Remove an account from Flat
-*FlatApi::OrganizationApi* | [**revoke_lti_credentials**](docs/OrganizationApi.md#revoke_lti_credentials) | **DELETE** /organizations/lti/credentials/{credentials} | Revoke LTI 1.x credentials
-*FlatApi::OrganizationApi* | [**update_organization_user**](docs/OrganizationApi.md#update_organization_user) | **PUT** /organizations/users/{user} | Update account information
-*FlatApi::ScoreApi* | [**add_score_collaborator**](docs/ScoreApi.md#add_score_collaborator) | **POST** /scores/{score}/collaborators | Add a new collaborator
-*FlatApi::ScoreApi* | [**add_score_track**](docs/ScoreApi.md#add_score_track) | **POST** /scores/{score}/tracks | Add a new video or audio track to the score
-*FlatApi::ScoreApi* | [**create_score**](docs/ScoreApi.md#create_score) | **POST** /scores | Create a new score
-*FlatApi::ScoreApi* | [**create_score_revision**](docs/ScoreApi.md#create_score_revision) | **POST** /scores/{score}/revisions | Create a new revision
-*FlatApi::ScoreApi* | [**delete_score**](docs/ScoreApi.md#delete_score) | **DELETE** /scores/{score} | Delete a score
-*FlatApi::ScoreApi* | [**delete_score_comment**](docs/ScoreApi.md#delete_score_comment) | **DELETE** /scores/{score}/comments/{comment} | Delete a comment
-*FlatApi::ScoreApi* | [**delete_score_track**](docs/ScoreApi.md#delete_score_track) | **DELETE** /scores/{score}/tracks/{track} | Remove an audio or video track linked to the score
-*FlatApi::ScoreApi* | [**edit_score**](docs/ScoreApi.md#edit_score) | **PUT** /scores/{score} | Edit a score's metadata
-*FlatApi::ScoreApi* | [**fork_score**](docs/ScoreApi.md#fork_score) | **POST** /scores/{score}/fork | Fork a score
-*FlatApi::ScoreApi* | [**ger_user_likes**](docs/ScoreApi.md#ger_user_likes) | **GET** /users/{user}/likes | List liked scores
-*FlatApi::ScoreApi* | [**get_group_scores**](docs/ScoreApi.md#get_group_scores) | **GET** /groups/{group}/scores | List group's scores
-*FlatApi::ScoreApi* | [**get_score**](docs/ScoreApi.md#get_score) | **GET** /scores/{score} | Get a score's metadata
-*FlatApi::ScoreApi* | [**get_score_collaborator**](docs/ScoreApi.md#get_score_collaborator) | **GET** /scores/{score}/collaborators/{collaborator} | Get a collaborator
-*FlatApi::ScoreApi* | [**get_score_collaborators**](docs/ScoreApi.md#get_score_collaborators) | **GET** /scores/{score}/collaborators | List the collaborators
-*FlatApi::ScoreApi* | [**get_score_comments**](docs/ScoreApi.md#get_score_comments) | **GET** /scores/{score}/comments | List comments
-*FlatApi::ScoreApi* | [**get_score_revision**](docs/ScoreApi.md#get_score_revision) | **GET** /scores/{score}/revisions/{revision} | Get a score revision
-*FlatApi::ScoreApi* | [**get_score_revision_data**](docs/ScoreApi.md#get_score_revision_data) | **GET** /scores/{score}/revisions/{revision}/{format} | Get a score revision data
-*FlatApi::ScoreApi* | [**get_score_revisions**](docs/ScoreApi.md#get_score_revisions) | **GET** /scores/{score}/revisions | List the revisions
-*FlatApi::ScoreApi* | [**get_score_submissions**](docs/ScoreApi.md#get_score_submissions) | **GET** /scores/{score}/submissions | List submissions related to the score
-*FlatApi::ScoreApi* | [**get_score_track**](docs/ScoreApi.md#get_score_track) | **GET** /scores/{score}/tracks/{track} | Retrieve the details of an audio or video track linked to a score
-*FlatApi::ScoreApi* | [**get_user_scores**](docs/ScoreApi.md#get_user_scores) | **GET** /users/{user}/scores | List user's scores
-*FlatApi::ScoreApi* | [**list_score_tracks**](docs/ScoreApi.md#list_score_tracks) | **GET** /scores/{score}/tracks | List the audio or video tracks linked to a score
-*FlatApi::ScoreApi* | [**mark_score_comment_resolved**](docs/ScoreApi.md#mark_score_comment_resolved) | **PUT** /scores/{score}/comments/{comment}/resolved | Mark the comment as resolved
-*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
-*FlatApi::UserApi* | [**get_user**](docs/UserApi.md#get_user) | **GET** /users/{user} | Get a public user profile
-*FlatApi::UserApi* | [**get_user_scores**](docs/UserApi.md#get_user_scores) | **GET** /users/{user}/scores | List user's scores
+## Supported versions
 
+Ruby 3.3 and 3.4. Versions past their upstream end of life are not supported; see
+[MIGRATION.md](MIGRATION.md) if you are on an older runtime.
 
-## Documentation for Models
+## Documentation
 
- - [FlatApi::Assignment](docs/Assignment.md)
- - [FlatApi::AssignmentCopy](docs/AssignmentCopy.md)
- - [FlatApi::AssignmentCreation](docs/AssignmentCreation.md)
- - [FlatApi::AssignmentSubmission](docs/AssignmentSubmission.md)
- - [FlatApi::AssignmentSubmissionUpdate](docs/AssignmentSubmissionUpdate.md)
- - [FlatApi::ClassAttachmentCreation](docs/ClassAttachmentCreation.md)
- - [FlatApi::ClassCreation](docs/ClassCreation.md)
- - [FlatApi::ClassDetails](docs/ClassDetails.md)
- - [FlatApi::ClassDetailsCanvas](docs/ClassDetailsCanvas.md)
- - [FlatApi::ClassDetailsClever](docs/ClassDetailsClever.md)
- - [FlatApi::ClassDetailsGoogleClassroom](docs/ClassDetailsGoogleClassroom.md)
- - [FlatApi::ClassDetailsGoogleDrive](docs/ClassDetailsGoogleDrive.md)
- - [FlatApi::ClassDetailsLti](docs/ClassDetailsLti.md)
- - [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)
- - [FlatApi::GoogleClassroomSubmission](docs/GoogleClassroomSubmission.md)
- - [FlatApi::Group](docs/Group.md)
- - [FlatApi::GroupDetails](docs/GroupDetails.md)
- - [FlatApi::GroupType](docs/GroupType.md)
- - [FlatApi::LicenseMode](docs/LicenseMode.md)
- - [FlatApi::LicenseSources](docs/LicenseSources.md)
- - [FlatApi::LmsName](docs/LmsName.md)
- - [FlatApi::LtiCredentials](docs/LtiCredentials.md)
- - [FlatApi::LtiCredentialsCreation](docs/LtiCredentialsCreation.md)
- - [FlatApi::MediaAttachment](docs/MediaAttachment.md)
- - [FlatApi::MediaScoreSharingMode](docs/MediaScoreSharingMode.md)
- - [FlatApi::OrganizationInvitation](docs/OrganizationInvitation.md)
- - [FlatApi::OrganizationInvitationCreation](docs/OrganizationInvitationCreation.md)
- - [FlatApi::OrganizationRoles](docs/OrganizationRoles.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)
- - [FlatApi::ScoreCommentUpdate](docs/ScoreCommentUpdate.md)
- - [FlatApi::ScoreCommentsCounts](docs/ScoreCommentsCounts.md)
- - [FlatApi::ScoreCreation](docs/ScoreCreation.md)
- - [FlatApi::ScoreCreationType](docs/ScoreCreationType.md)
- - [FlatApi::ScoreData](docs/ScoreData.md)
- - [FlatApi::ScoreDataEncoding](docs/ScoreDataEncoding.md)
- - [FlatApi::ScoreFork](docs/ScoreFork.md)
- - [FlatApi::ScoreLicense](docs/ScoreLicense.md)
- - [FlatApi::ScoreLikesCounts](docs/ScoreLikesCounts.md)
- - [FlatApi::ScoreModification](docs/ScoreModification.md)
- - [FlatApi::ScorePrivacy](docs/ScorePrivacy.md)
- - [FlatApi::ScoreRevision](docs/ScoreRevision.md)
- - [FlatApi::ScoreRevisionCreation](docs/ScoreRevisionCreation.md)
- - [FlatApi::ScoreRevisionStatistics](docs/ScoreRevisionStatistics.md)
- - [FlatApi::ScoreSource](docs/ScoreSource.md)
- - [FlatApi::ScoreSummary](docs/ScoreSummary.md)
- - [FlatApi::ScoreTrack](docs/ScoreTrack.md)
- - [FlatApi::ScoreTrackCreation](docs/ScoreTrackCreation.md)
- - [FlatApi::ScoreTrackPoint](docs/ScoreTrackPoint.md)
- - [FlatApi::ScoreTrackState](docs/ScoreTrackState.md)
- - [FlatApi::ScoreTrackType](docs/ScoreTrackType.md)
- - [FlatApi::ScoreTrackUpdate](docs/ScoreTrackUpdate.md)
- - [FlatApi::ScoreViewsCounts](docs/ScoreViewsCounts.md)
- - [FlatApi::UserAdminUpdate](docs/UserAdminUpdate.md)
- - [FlatApi::UserBasics](docs/UserBasics.md)
- - [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)
- - [FlatApi::UserPublic](docs/UserPublic.md)
- - [FlatApi::UserDetails](docs/UserDetails.md)
+- [Quickstart](QUICKSTART.md), install to first call
+- [Per-operation reference](docs/reference/), generated
+- [API documentation](https://flat.io/developers/docs/api/)
+- [Migrating from 0.3.x](MIGRATION.md)
 
+## Verifying this gem
+
+Published through RubyGems trusted publishing, so no long-lived API key exists that could publish
+under this name. The release workflow is the only publisher, and each release is tied to the commit
+and the API specification version it was generated from.
+
+```sh
+gem fetch flat_api
+gem spec flat_api-*.gem
+```
 
-## Documentation for Authorization
+## How this client is maintained
 
+Generated from the public specification published at
+[FlatIO/api-reference](https://github.com/FlatIO/api-reference). A new specification release
+regenerates, validates and publishes this package automatically, so it never drifts from the API.
 
-### OAuth2
+Files under `docs/reference/` and the client sources are generated: edit the generator configuration
+in `tools/`, not the output.
 
-- **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. 
-  - 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.
-  - edu.assignments.readonly: Read-only access to the assignments and submissions.
-  - edu.admin: Full, permissive scope to manage all the admin of an organization.
-  - edu.admin.lti: Access and manage the LTI Credentials for an organization.
-  - 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.
+## License
 
+Apache 2.0. See [LICENSE](LICENSE).