class FlatApi::ScoreCreation
A new created score
Attributes
Unique identifier of a collection where the score will be created. If no collection identifier is provided, the score will be stored in the `root` directory.
If the user uses Google Drive and this properties is specified, the file will be created in this directory. The currently user creating the file must be granted to write in this directory.
The title of the new score. If the title is too long, the API may trim this one. If this title is not specified, the API will try to (in this order): - Use the name of the file for files from a specified `source` (e.g. Google Drive) - Use the title contained in the file (e.g. [`movement-title`](usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-movement-title.htm) or [`credit-words`](usermanuals.musicxml.com/MusicXML/Content/EL-MusicXML-credit-words.htm) for [MusicXML](www.musicxml.com/) files). - Set a default title (e.g. "New Music Score")
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/flat_api/models/score_creation.rb, line 37 def self.attribute_map { :'title' => :'title', :'privacy' => :'privacy', :'data' => :'data', :'data_encoding' => :'dataEncoding', :'source' => :'source', :'collection' => :'collection', :'google_drive_folder' => :'googleDriveFolder' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/flat_api/models/score_creation.rb, line 64 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?(:'title') self.title = attributes[:'title'] end if attributes.has_key?(:'privacy') self.privacy = attributes[:'privacy'] end if attributes.has_key?(:'data') self.data = attributes[:'data'] end if attributes.has_key?(:'dataEncoding') self.data_encoding = attributes[:'dataEncoding'] end if attributes.has_key?(:'source') self.source = attributes[:'source'] end if attributes.has_key?(:'collection') self.collection = attributes[:'collection'] end if attributes.has_key?(:'googleDriveFolder') self.google_drive_folder = attributes[:'googleDriveFolder'] end end
Attribute type mapping.
# File lib/flat_api/models/score_creation.rb, line 50 def self.swagger_types { :'title' => :'String', :'privacy' => :'ScorePrivacy', :'data' => :'ScoreData', :'data_encoding' => :'ScoreDataEncoding', :'source' => :'ScoreSource', :'collection' => :'String', :'google_drive_folder' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/flat_api/models/score_creation.rb, line 120 def ==(o) return true if self.equal?(o) self.class == o.class && title == o.title && privacy == o.privacy && data == o.data && data_encoding == o.data_encoding && source == o.source && collection == o.collection && google_drive_folder == o.google_drive_folder end
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_creation.rb, line 168 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
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_creation.rb, line 234 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
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_creation.rb, line 147 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
@see the `==` method @param [Object] Object to be compared
# File lib/flat_api/models/score_creation.rb, line 134 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/flat_api/models/score_creation.rb, line 140 def hash [title, privacy, data, data_encoding, source, collection, google_drive_folder].hash end
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_creation.rb, line 102 def list_invalid_properties invalid_properties = Array.new if @privacy.nil? invalid_properties.push("invalid value for 'privacy', privacy cannot be nil.") end return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/flat_api/models/score_creation.rb, line 220 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/flat_api/models/score_creation.rb, line 208 def to_s to_hash.to_s end
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_creation.rb, line 113 def valid? return false if @privacy.nil? return true end