action flat_edit_score {
  label: "Edit a score's metadata"
  description: "This API method allows you to change the metadata of a score document (e.g. its `title` or `privacy`), all the properties are optional.\n\nTo edit the file itself, create a new revision using the appropriate method (`POST /v2/scores/{score}/revisions/{revision}`).\n\nWhen editing the `title`, `subtitle`, `composer`, `lyricist`, `arranger` or `licenseText`, the metadatas will be instantly be updated, and a real-time action will be pushed to update the document lazily.\nThis pending document modification will be automatically be saved as a new version by either a connected client or our internal versioning service.\n"
  provider: flat
  method: PUT
  path: "/scores/{score}"
  encoding: json
  input: {
    type: "object"
    description: "Edit the score metadata"
    properties: {
      arranger: {
        type: "string"
        description: "The arranger of the score"
      }
      composer: {
        type: "string"
        description: "The composer of the score"
      }
      creationType: {
        type: "string"
        description: "The type of creation (an orginal, an arrangement)"
        enum: ["original", "arrangement", "other"]
      }
      description: {
        type: "string"
        description: "Description of the creation"
      }
      license: {
        type: "string"
        description: "License of the creation. Read more about the Creative Commons licenses on https://creativecommons.org/licenses/\n"
        enum: ["copyright", "cc0", "cc-by", "cc-by-sa", "cc-by-nd", "cc-by-nc", "cc-by-nc-sa", "cc-by-nc-nd"]
      }
      licenseText: {
        type: "string"
        description: "The rights info written on the score"
      }
      lyricist: {
        type: "string"
        description: "The lyricist of the score"
      }
      privacy: {
        type: "string"
        description: "The score main privacy mode.\n\n- `public`: The score is public on the Internet. This one can be accessible at the url `https://flat.io/score/{score}` and can be modified and administred by specified collaborators users.\n- `private`: The score is private and can be only accessed, modified and administred by specified collaborators users.\n- `privateLink`: The score is private but can be accessed using a private link `htmlUrl` or the private key in the property `sharingKey`.\n- `organizationPublic`: _Available only with [Flat for Education](https://flat.io/edu)._ The score is public in the organization: users of the same organization can access to this one. The score can be modified and administred by specified collaborators users.\n\nThe score can also be individually shared to a set of users or groups using the different collaborators API methods.\n\nWhen a file is synchronized from an external source (e.g. Google Drive) and the sharing options are changed on the source, Flat will chose the best privacy mode for the file.\n\nWhen using a [Flat for Education](https://flat.io/edu) account, some of the modes may not be available if disabled by an administrator of the organization (e.g. by default the `public` mode is not available).\n"
        enum: ["public", "private", "organizationPublic", "privateLink"]
      }
      sharingKey: {
        type: "string"
        description: "When using the `privacy` mode `privateLink`, this property can be used to set a custom sharing key, otherwise a new key will be generated."
      }
      subtitle: {
        type: "string"
        description: "The subtitle of the score"
      }
      tags: {
        type: "array"
        description: "Tags describing the score"
        items: {
          type: "string"
        }
      }
      title: {
        type: "string"
        description: "The title of the score"
      }
    }
  }
  output: {
    description: "The score and all its details"
    type: "object"
  }
}