class FlatApi::Collection

Collection of scores

Attributes

app[RW]

If this directory is dedicated to an app, the unique idenfier of this app

capabilities[RW]
collaborators[RW]

The list of the collaborators of the collection

html_url[RW]

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

id[RW]

Unique identifier of the collection

privacy[RW]
rights[RW]
sharing_key[RW]

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

title[RW]
type[RW]
user[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/collection.rb, line 47
def self.attribute_map
  {
    :'id' => :'id',
    :'title' => :'title',
    :'html_url' => :'htmlUrl',
    :'type' => :'type',
    :'privacy' => :'privacy',
    :'sharing_key' => :'sharingKey',
    :'app' => :'app',
    :'user' => :'user',
    :'rights' => :'rights',
    :'collaborators' => :'collaborators',
    :'capabilities' => :'capabilities'
  }
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/collection.rb, line 82
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?(:'title')
    self.title = attributes[:'title']
  end

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

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

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

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

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

  if attributes.has_key?(:'user')
    self.user = attributes[:'user']
  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?(:'capabilities')
    self.capabilities = attributes[:'capabilities']
  end

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/flat_api/models/collection.rb, line 64
def self.swagger_types
  {
    :'id' => :'String',
    :'title' => :'CollectionTitle',
    :'html_url' => :'String',
    :'type' => :'CollectionType',
    :'privacy' => :'CollectionPrivacy',
    :'sharing_key' => :'String',
    :'app' => :'String',
    :'user' => :'UserPublicSummary',
    :'rights' => :'ResourceRights',
    :'collaborators' => :'Array<ResourceCollaborator>',
    :'capabilities' => :'CollectionCapabilities'
  }
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/collection.rb, line 151
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      title == o.title &&
      html_url == o.html_url &&
      type == o.type &&
      privacy == o.privacy &&
      sharing_key == o.sharing_key &&
      app == o.app &&
      user == o.user &&
      rights == o.rights &&
      collaborators == o.collaborators &&
      capabilities == o.capabilities
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/collection.rb, line 203
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/collection.rb, line 269
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/collection.rb, line 182
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/collection.rb, line 169
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/collection.rb, line 175
def hash
  [id, title, html_url, type, privacy, sharing_key, app, user, rights, collaborators, capabilities].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/collection.rb, line 138
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/collection.rb, line 249
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/collection.rb, line 255
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/collection.rb, line 243
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/collection.rb, line 145
def valid?
  return true
end