action figshare_private_collection_update {
  label: "Update collection"
  description: "Update collection details; request can also be made with the PATCH method."
  provider: figshare
  method: PUT
  path: "/account/collections/{collection_id}"
  encoding: json
  input: {
    type: "object"
    properties: {
      articles: {
        type: "array"
        description: "List of articles to be associated with the collection"
        items: {
          type: "integer"
        }
      }
      authors: {
        type: "array"
        description: "List of authors to be associated with the collection. The list can contain the following fields: id, name, first_name, last_name, email, orcid_id. If an id is supplied, it will take priority and everything else will be ignored. No more than 10 authors. For adding more authors use the specific authors endpoint."
        items: {
          type: "object"
        }
      }
      categories: {
        type: "array"
        description: "List of category ids to be associated with the collection (e.g [1, 23, 33, 66])"
        items: {
          type: "integer"
          format: "int64"
        }
      }
      categories_by_source_id: {
        type: "array"
        description: "List of category source ids to be associated with the article, supersedes the categories property"
        items: {
          type: "string"
        }
      }
      custom_fields: {
        type: "object"
        description: "List of key, values pairs to be associated with the collection"
      }
      custom_fields_list: {
        type: "array"
        description: "List of custom fields values, supersedes custom_fields parameter"
        items: {
          type: "object"
          required: ["name", "value"]
          properties: {
            name: {
              type: "string"
              description: "Custom  metadata name"
            }
            value: {
              description: "Custom metadata value"
              type: "object"
            }
          }
        }
      }
      description: {
        type: "string"
        description: "The collection description. In a publisher case, usually this is the remote collection description"
      }
      doi: {
        type: "string"
        description: "Not applicable for regular users. In an institutional case, make sure your group supports setting DOIs. This setting is applied by figshare via opening a ticket through our support/helpdesk system."
      }
      funding: {
        type: "string"
        description: "Grant number or funding authority"
      }
      funding_list: {
        type: "array"
        description: "Funding creation / update items"
        items: {
          type: "object"
          properties: {
            id: {
              type: "integer"
              format: "int64"
              description: "A funding ID as returned by the Funding Search endpoint"
            }
            title: {
              type: "string"
              description: "The title of the new user created funding"
            }
          }
        }
      }
      group_id: {
        type: "integer"
        format: "int64"
        description: "Not applicable to regular users. This field is reserved to institutions/publishers with access to assign to specific groups"
      }
      handle: {
        type: "string"
        description: "Not applicable for regular users. In an institutional case, make sure your group supports setting Handles. This setting is applied by figshare via opening a ticket through our support/helpdesk system."
      }
      keywords: {
        type: "array"
        description: "List of tags to be associated with the collection. Tags can be used instead"
        items: {
          type: "string"
        }
      }
      references: {
        type: "array"
        description: "List of links to be associated with the collection (e.g [\"http://link1\", \"http://link2\", \"http://link3\"])"
        items: {
          type: "string"
          format: "link"
        }
      }
      resource_doi: {
        type: "string"
        description: "Not applicable to regular users. In a publisher case, this is the publisher article DOI."
      }
      resource_id: {
        type: "string"
        description: "Not applicable to regular users. In a publisher case, this is the publisher article id"
      }
      resource_link: {
        type: "string"
        description: "Not applicable to regular users. In a publisher case, this is the publisher article link"
      }
      resource_title: {
        type: "string"
        description: "Not applicable to regular users. In a publisher case, this is the publisher article title."
      }
      resource_version: {
        type: "integer"
        description: "Not applicable to regular users. In a publisher case, this is the publisher article version"
      }
      tags: {
        type: "array"
        description: "List of tags to be associated with the collection. Keywords can be used instead"
        items: {
          type: "string"
        }
      }
      timeline: {
        type: "object"
        properties: {
          firstOnline: {
            type: "string"
            description: "Online posted date"
          }
          publisherAcceptance: {
            type: "string"
            description: "Date when the item was accepted for publication"
          }
          publisherPublication: {
            type: "string"
            description: "Publish date"
          }
        }
      }
      title: {
        type: "string"
        description: "Title of collection"
      }
    }
  }
  output: {
    type: "object"
    additionalProperties: true
  }
}