feat(client): Update to API specification v2.4

Author: gierschv

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 0.5.0
+
+* feat(scores): New metadata and update of `PUT /v2/scores/{score}`:
+  * Added metadata in API `subtitle`, `lyricist`, `composer`, `description`, `tags`, `creationType`, `license`, `licenseText`, `durationTime`, `numberMeasures`, `mainTempoQpm`, `publicationDate`.
+  * `PUT /v2/scores/{score}`: Remove `title` property, this one can be updated by saving a new revision of the score data.
+  * `PUT /v2/scores/{score}`: New settable properties: `description`, `tags`, `creationType`, `license`.
+
 ## 0.4.0
 
 * feat(user): Add profile theme and instruments played.

README.md

@@ -182,9 +182,11 @@ Class | Method | HTTP request | Description
  - [ScoreCommentUpdate](docs/ScoreCommentUpdate.md)
  - [ScoreCommentsCounts](docs/ScoreCommentsCounts.md)
  - [ScoreCreation](docs/ScoreCreation.md)
+ - [ScoreCreationType](docs/ScoreCreationType.md)
  - [ScoreData](docs/ScoreData.md)
  - [ScoreDataEncoding](docs/ScoreDataEncoding.md)
  - [ScoreFork](docs/ScoreFork.md)
+ - [ScoreLicense](docs/ScoreLicense.md)
  - [ScoreLikesCounts](docs/ScoreLikesCounts.md)
  - [ScoreModification](docs/ScoreModification.md)
  - [ScorePrivacy](docs/ScorePrivacy.md)

docs/ScoreCreationType.md

@@ -0,0 +1,9 @@
+# ScoreCreationType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/ScoreDetails.md

@@ -9,10 +9,22 @@ Name | Type | Description | Notes
 **privacy** | [**ScorePrivacy**](ScorePrivacy.md) |  | [optional] 
 **user** | [**UserPublicSummary**](UserPublicSummary.md) |  | [optional] 
 **html_url** | **str** | The url where the score can be viewed in a web browser | [optional] 
+**subtitle** | **str** | Subtitle of the score | [optional] 
+**lyricist** | **str** | Lyricist of the score | [optional] 
+**composer** | **str** | Composer of the score | [optional] 
+**description** | **str** | Description of the creation | [optional] 
+**tags** | **list[str]** | Tags describing the score | [optional] 
+**creation_type** | [**ScoreCreationType**](ScoreCreationType.md) |  | [optional] 
+**license** | [**ScoreLicense**](ScoreLicense.md) |  | [optional] 
+**license_text** | **str** | Additional license text written on the exported/printed score | [optional] 
+**duration_time** | **int** | In seconds, an approximative duration of the score | [optional] 
+**number_measures** | **int** | The number of measures in the score | [optional] 
+**main_tempo_qpm** | **int** | The main tempo of the score (in QPM) | [optional] 
 **rights** | [**ScoreRights**](ScoreRights.md) |  | [optional] 
 **collaborators** | [**list[ScoreCollaborator]**](ScoreCollaborator.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] 
 **organization** | **str** | If the score has been created in an organization, the identifier of this organization. This property is especially used with the score privacy `organizationPublic`.  | [optional] 
 **parent_score** | **str** | If the score has been forked, the unique identifier of the parent score.  | [optional] 
 **instruments** | **list[str]** | An array of the instrument identifiers used in the last version of the score. This is mainly used to display a list of the instruments in the Flat's UI or instruments icons. The format of the strings is `{instrument-group}.{instrument-id}`.  | [optional] 

docs/ScoreLicense.md

@@ -0,0 +1,9 @@
+# ScoreLicense
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

docs/ScoreModification.md

@@ -4,8 +4,11 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **privacy** | [**ScorePrivacy**](ScorePrivacy.md) |  | [optional] 
-**title** | **str** | A new title of the score | [optional] 
 **sharing_key** | **str** | 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] 
+**description** | **str** | Description of the creation | [optional] 
+**tags** | **list[str]** | Tags describing the score | [optional] 
+**creation_type** | [**ScoreCreationType**](ScoreCreationType.md) |  | [optional] 
+**license** | [**ScoreLicense**](ScoreLicense.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

flat_api/__init__.py

@@ -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.2.0
+    OpenAPI spec version: 2.4.0
     Contact: developers@flat.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
@@ -55,9 +55,11 @@
 from .models.score_comment_update import ScoreCommentUpdate
 from .models.score_comments_counts import ScoreCommentsCounts
 from .models.score_creation import ScoreCreation
+from .models.score_creation_type import ScoreCreationType
 from .models.score_data import ScoreData
 from .models.score_data_encoding import ScoreDataEncoding
 from .models.score_fork import ScoreFork
+from .models.score_license import ScoreLicense
 from .models.score_likes_counts import ScoreLikesCounts
 from .models.score_modification import ScoreModification
 from .models.score_privacy import ScorePrivacy

flat_api/api_client.py

@@ -4,7 +4,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.2.0
+    OpenAPI spec version: 2.4.0
     Contact: developers@flat.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

flat_api/apis/account_api.py

@@ -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.2.0
+    OpenAPI spec version: 2.4.0
     Contact: developers@flat.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """

flat_api/apis/class_api.py

@@ -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.2.0
+    OpenAPI spec version: 2.4.0
     Contact: developers@flat.io
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """