class FlatApi::ScoreDetails

The score and all its details

Attributes

collaborators[RW]

The list of the collaborators of the score

comments[RW]
composer[RW]

Composer of the score

creation_date[RW]

The date when the score was created

creation_type[RW]
description[RW]

Description of the creation

duration_time[RW]

In seconds, an approximative duration of the score

google_drive_file_id[RW]

If the user uses Google Drive and the score exists on Google Drive, this field will contain the unique identifier of the Flat score on Google Drive. You can access the document using the url: `drive.google.com/open?id={googleDriveFileId}`

html_url[RW]

The url where the score can be viewed in a web browser

id[RW]

The unique identifier of the score

instruments[RW]

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}`.

license[RW]
license_text[RW]

Additional license text written on the exported/printed score

likes[RW]
lyricist[RW]

Lyricist of the score

main_tempo_qpm[RW]

The main tempo of the score (in QPM)

modification_date[RW]

The date of the last revision of the score

number_measures[RW]

The number of measures in the score

organization[RW]

If the score has been created in an organization, the identifier of this organization. This property is especially used with the score privacy `organizationPublic`.

parent_score[RW]

If the score has been forked, the unique identifier of the parent score.

privacy[RW]
publication_date[RW]

The date when the score was published on Flat

rights[RW]
sharing_key[RW]

The private sharing key of the score (available when the `privacy` mode is set to `privateLink`)

subtitle[RW]

Subtitle of the score

tags[RW]

Tags describing the score

title[RW]

The title of the score

user[RW]
views[RW]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/flat_api/models/score_details.rb, line 99
def self.attribute_map
  {
    :'id' => :'id',
    :'sharing_key' => :'sharingKey',
    :'title' => :'title',
    :'privacy' => :'privacy',
    :'user' => :'user',
    :'html_url' => :'htmlUrl',
    :'subtitle' => :'subtitle',
    :'lyricist' => :'lyricist',
    :'composer' => :'composer',
    :'description' => :'description',
    :'tags' => :'tags',
    :'creation_type' => :'creationType',
    :'license' => :'license',
    :'license_text' => :'licenseText',
    :'duration_time' => :'durationTime',
    :'number_measures' => :'numberMeasures',
    :'main_tempo_qpm' => :'mainTempoQpm',
    :'rights' => :'rights',
    :'collaborators' => :'collaborators',
    :'creation_date' => :'creationDate',
    :'modification_date' => :'modificationDate',
    :'publication_date' => :'publicationDate',
    :'organization' => :'organization',
    :'parent_score' => :'parentScore',
    :'instruments' => :'instruments',
    :'google_drive_file_id' => :'googleDriveFileId',
    :'likes' => :'likes',
    :'comments' => :'comments',
    :'views' => :'views'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/flat_api/models/score_details.rb, line 170
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'sharingKey')
    self.sharing_key = attributes[:'sharingKey']
  end

  if attributes.has_key?(:'title')
    self.title = attributes[:'title']
  end

  if attributes.has_key?(:'privacy')
    self.privacy = attributes[:'privacy']
  end

  if attributes.has_key?(:'user')
    self.user = attributes[:'user']
  end

  if attributes.has_key?(:'htmlUrl')
    self.html_url = attributes[:'htmlUrl']
  end

  if attributes.has_key?(:'subtitle')
    self.subtitle = attributes[:'subtitle']
  end

  if attributes.has_key?(:'lyricist')
    self.lyricist = attributes[:'lyricist']
  end

  if attributes.has_key?(:'composer')
    self.composer = attributes[:'composer']
  end

  if attributes.has_key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.has_key?(:'tags')
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  end

  if attributes.has_key?(:'creationType')
    self.creation_type = attributes[:'creationType']
  end

  if attributes.has_key?(:'license')
    self.license = attributes[:'license']
  end

  if attributes.has_key?(:'licenseText')
    self.license_text = attributes[:'licenseText']
  end

  if attributes.has_key?(:'durationTime')
    self.duration_time = attributes[:'durationTime']
  end

  if attributes.has_key?(:'numberMeasures')
    self.number_measures = attributes[:'numberMeasures']
  end

  if attributes.has_key?(:'mainTempoQpm')
    self.main_tempo_qpm = attributes[:'mainTempoQpm']
  end

  if attributes.has_key?(:'rights')
    self.rights = attributes[:'rights']
  end

  if attributes.has_key?(:'collaborators')
    if (value = attributes[:'collaborators']).is_a?(Array)
      self.collaborators = value
    end
  end

  if attributes.has_key?(:'creationDate')
    self.creation_date = attributes[:'creationDate']
  end

  if attributes.has_key?(:'modificationDate')
    self.modification_date = attributes[:'modificationDate']
  end

  if attributes.has_key?(:'publicationDate')
    self.publication_date = attributes[:'publicationDate']
  end

  if attributes.has_key?(:'organization')
    self.organization = attributes[:'organization']
  end

  if attributes.has_key?(:'parentScore')
    self.parent_score = attributes[:'parentScore']
  end

  if attributes.has_key?(:'instruments')
    if (value = attributes[:'instruments']).is_a?(Array)
      self.instruments = value
    end
  end

  if attributes.has_key?(:'googleDriveFileId')
    self.google_drive_file_id = attributes[:'googleDriveFileId']
  end

  if attributes.has_key?(:'likes')
    self.likes = attributes[:'likes']
  end

  if attributes.has_key?(:'comments')
    self.comments = attributes[:'comments']
  end

  if attributes.has_key?(:'views')
    self.views = attributes[:'views']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/flat_api/models/score_details.rb, line 134
def self.swagger_types
  {
    :'id' => :'String',
    :'sharing_key' => :'String',
    :'title' => :'String',
    :'privacy' => :'ScorePrivacy',
    :'user' => :'UserPublicSummary',
    :'html_url' => :'String',
    :'subtitle' => :'String',
    :'lyricist' => :'String',
    :'composer' => :'String',
    :'description' => :'String',
    :'tags' => :'Array<String>',
    :'creation_type' => :'ScoreCreationType',
    :'license' => :'ScoreLicense',
    :'license_text' => :'String',
    :'duration_time' => :'Integer',
    :'number_measures' => :'Integer',
    :'main_tempo_qpm' => :'Integer',
    :'rights' => :'ResourceRights',
    :'collaborators' => :'Array<ResourceCollaborator>',
    :'creation_date' => :'DateTime',
    :'modification_date' => :'DateTime',
    :'publication_date' => :'DateTime',
    :'organization' => :'String',
    :'parent_score' => :'String',
    :'instruments' => :'Array<String>',
    :'google_drive_file_id' => :'String',
    :'likes' => :'ScoreLikesCounts',
    :'comments' => :'ScoreCommentsCounts',
    :'views' => :'ScoreViewsCounts'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/flat_api/models/score_details.rb, line 315
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      sharing_key == o.sharing_key &&
      title == o.title &&
      privacy == o.privacy &&
      user == o.user &&
      html_url == o.html_url &&
      subtitle == o.subtitle &&
      lyricist == o.lyricist &&
      composer == o.composer &&
      description == o.description &&
      tags == o.tags &&
      creation_type == o.creation_type &&
      license == o.license &&
      license_text == o.license_text &&
      duration_time == o.duration_time &&
      number_measures == o.number_measures &&
      main_tempo_qpm == o.main_tempo_qpm &&
      rights == o.rights &&
      collaborators == o.collaborators &&
      creation_date == o.creation_date &&
      modification_date == o.modification_date &&
      publication_date == o.publication_date &&
      organization == o.organization &&
      parent_score == o.parent_score &&
      instruments == o.instruments &&
      google_drive_file_id == o.google_drive_file_id &&
      likes == o.likes &&
      comments == o.comments &&
      views == o.views
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/flat_api/models/score_details.rb, line 385
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = FlatApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/flat_api/models/score_details.rb, line 451
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/flat_api/models/score_details.rb, line 364
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/flat_api/models/score_details.rb, line 351
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/flat_api/models/score_details.rb, line 357
def hash
  [id, sharing_key, title, privacy, user, html_url, subtitle, lyricist, composer, description, tags, creation_type, license, license_text, duration_time, number_measures, main_tempo_qpm, rights, collaborators, creation_date, modification_date, publication_date, organization, parent_score, instruments, google_drive_file_id, likes, comments, views].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/flat_api/models/score_details.rb, line 302
def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/flat_api/models/score_details.rb, line 431
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/flat_api/models/score_details.rb, line 437
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/flat_api/models/score_details.rb, line 425
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/flat_api/models/score_details.rb, line 309
def valid?
  return true
end