Collection.md

FlatApi::Collection

Properties

Name	Type	Description	Notes
id	String	Unique identifier of the collection
title	String	The title of the collection
html_url	String	The url where the collection can be viewed in a web browser
type	CollectionType
label_key	String	Product-specific translation key for the collection type. Only set for specific collection types: * For `regular` type: `playlist` (Flat) or `collection` (Flat for Education) * For `collaborations` type: `collaboration` (Flat) or `shared-scores` (Flat for Education) Not set for other collection types.	[optional]
privacy	CollectionPrivacy		[default to 'private']
sharing_key	String	The private sharing key of the collection (available when the `privacy` mode is set to `privateLink`)	[optional]
app	CollectionApp		[optional]
creation_date	Time	The date when the collection was created
modification_date	Time	The date when the collection was last modified	[optional]
user	UserPublicSummary		[optional]
organization	String	If the score has been created in an organization, the identifier of this organization.	[optional]
rights	ResourceRights		[optional]
collaborators	Array<ResourceCollaborator>	The list of the collaborators of the collection	[optional]
is_pinned	Boolean	Whether the collection is pinned by the owner	[optional]
contents	CollectionContents
capabilities	CollectionCapabilities
collections	Array<String>	The list of parent collections this score is included in. Please note that you might not have access to all of them.	[optional]

Example

require 'flat_api'

instance = FlatApi::Collection.new(
  id: null,
  title: null,
  html_url: null,
  type: null,
  label_key: null,
  privacy: null,
  sharing_key: null,
  app: null,
  creation_date: null,
  modification_date: null,
  user: null,
  organization: null,
  rights: null,
  collaborators: null,
  is_pinned: null,
  contents: null,
  capabilities: null,
  collections: null
)