flat_api 0.2.0 → 0.3.5

data/lib/flat_api/models/score_details.rb

@@ -1,16 +1,17 @@
 =begin
 #Flat API
 
-#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following:  * Creating and importing new music scores using MusicXML or MIDI files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments.  The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/).  You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference).  Getting Started and learn more:  * [API Overview and interoduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html) 
+#The Flat API allows you to easily extend the abilities of the [Flat Platform](https://flat.io), with a wide range of use cases including the following:  * Creating and importing new music scores using MusicXML, MIDI, Guitar Pro (GP3, GP4, GP5, GPX, GP), PowerTab, TuxGuitar and MuseScore files * Browsing, updating, copying, exporting the user's scores (for example in MP3, WAV or MIDI) * Managing educational resources with Flat for Education: creating & updating the organization accounts, the classes, rosters and assignments.  The Flat API is built on HTTP. Our API is RESTful It has predictable resource URLs. It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body. The [schema](/swagger.yaml) of this API follows the [OpenAPI Initiative (OAI) specification](https://www.openapis.org/), you can use and work with [compatible Swagger tools](http://swagger.io/open-source-integrations/). This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/).  You can use your favorite HTTP/REST library for your programming language to use Flat's API. This specification and reference is [available on Github](https://github.com/FlatIO/api-reference).  Getting Started and learn more:  * [API Overview and introduction](https://flat.io/developers/docs/api/) * [Authentication (Personal Access Tokens or OAuth2)](https://flat.io/developers/docs/api/authentication.html) * [SDKs](https://flat.io/developers/docs/api/sdks.html) * [Rate Limits](https://flat.io/developers/docs/api/rate-limits.html) * [Changelog](https://flat.io/developers/docs/api/changelog.html) 
 
-OpenAPI spec version: 2.6.0
+The version of the OpenAPI document: 2.20.0
 Contact: developers@flat.io
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.0-SNAPSHOT
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.3.0
 
 =end
 
 require 'date'
+require 'time'
 
 module FlatApi
   # The score and all its details
@@ -37,6 +38,9 @@ module FlatApi
     # Lyricist of the score
     attr_accessor :lyricist
 
+    # Arranger of the score
+    attr_accessor :arranger
+
     # Composer of the score
     attr_accessor :composer
 
@@ -62,6 +66,9 @@ module FlatApi
     # The main tempo of the score (in QPM)
     attr_accessor :main_tempo_qpm
 
+    # The main key signature of the score (expressed between -7 and 7).
+    attr_accessor :main_key_signature
+
     attr_accessor :rights
 
     # The list of the collaborators of the score
@@ -76,6 +83,9 @@ module FlatApi
     # The date when the score was published on Flat
     attr_accessor :publication_date
 
+    # The date when the score was highlighted (featured) on our community
+    attr_accessor :highlighted_date
+
     # If the score has been created in an organization, the identifier of this organization. This property is especially used with the score privacy `organizationPublic`. 
     attr_accessor :organization
 
@@ -85,6 +95,9 @@ module FlatApi
     # 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}`. 
     attr_accessor :instruments
 
+    # An array of the audio samples identifiers used the different score parts. The format of the strings is `{instrument-group}.{sample-id}`. 
+    attr_accessor :samples
+
     # 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: `https://drive.google.com/open?id={googleDriveFileId}` 
     attr_accessor :google_drive_file_id
 
@@ -94,6 +107,32 @@ module FlatApi
 
     attr_accessor :views
 
+    attr_accessor :plays
+
+    # The List of parent collections, which includes all the collections this score is included. Please note that you might not have access to all of them.
+    attr_accessor :collections
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
@@ -106,6 +145,7 @@ module FlatApi
         :'html_url' => :'htmlUrl',
         :'subtitle' => :'subtitle',
         :'lyricist' => :'lyricist',
+        :'arranger' => :'arranger',
         :'composer' => :'composer',
         :'description' => :'description',
         :'tags' => :'tags',
@@ -115,199 +155,336 @@ module FlatApi
         :'duration_time' => :'durationTime',
         :'number_measures' => :'numberMeasures',
         :'main_tempo_qpm' => :'mainTempoQpm',
+        :'main_key_signature' => :'mainKeySignature',
         :'rights' => :'rights',
         :'collaborators' => :'collaborators',
         :'creation_date' => :'creationDate',
         :'modification_date' => :'modificationDate',
         :'publication_date' => :'publicationDate',
+        :'highlighted_date' => :'highlightedDate',
         :'organization' => :'organization',
         :'parent_score' => :'parentScore',
         :'instruments' => :'instruments',
+        :'samples' => :'samples',
         :'google_drive_file_id' => :'googleDriveFileId',
         :'likes' => :'likes',
         :'comments' => :'comments',
-        :'views' => :'views'
+        :'views' => :'views',
+        :'plays' => :'plays',
+        :'collections' => :'collections'
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
         :'id' => :'String',
         :'sharing_key' => :'String',
         :'title' => :'String',
         :'privacy' => :'ScorePrivacy',
-        :'user' => :'UserPublicSummary',
+        :'user' => :'UserPublic',
         :'html_url' => :'String',
         :'subtitle' => :'String',
         :'lyricist' => :'String',
+        :'arranger' => :'String',
         :'composer' => :'String',
         :'description' => :'String',
         :'tags' => :'Array<String>',
         :'creation_type' => :'ScoreCreationType',
         :'license' => :'ScoreLicense',
         :'license_text' => :'String',
-        :'duration_time' => :'Integer',
+        :'duration_time' => :'Float',
         :'number_measures' => :'Integer',
-        :'main_tempo_qpm' => :'Integer',
+        :'main_tempo_qpm' => :'Float',
+        :'main_key_signature' => :'Float',
         :'rights' => :'ResourceRights',
         :'collaborators' => :'Array<ResourceCollaborator>',
-        :'creation_date' => :'DateTime',
-        :'modification_date' => :'DateTime',
-        :'publication_date' => :'DateTime',
+        :'creation_date' => :'Time',
+        :'modification_date' => :'Time',
+        :'publication_date' => :'Time',
+        :'highlighted_date' => :'Time',
         :'organization' => :'String',
         :'parent_score' => :'String',
         :'instruments' => :'Array<String>',
+        :'samples' => :'Array<String>',
         :'google_drive_file_id' => :'String',
         :'likes' => :'ScoreLikesCounts',
         :'comments' => :'ScoreCommentsCounts',
-        :'views' => :'ScoreViewsCounts'
+        :'views' => :'ScoreViewsCounts',
+        :'plays' => :'ScorePlaysCounts',
+        :'collections' => :'Array<String>'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'creation_type',
+        :'license',
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'ScoreSummary'
+      ]
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::ScoreDetails` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ScoreDetails`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
 
-      if attributes.has_key?(:'id')
+      if attributes.key?(:'id')
         self.id = attributes[:'id']
+      else
+        self.id = nil
       end
 
-      if attributes.has_key?(:'sharingKey')
-        self.sharing_key = attributes[:'sharingKey']
+      if attributes.key?(:'sharing_key')
+        self.sharing_key = attributes[:'sharing_key']
       end
 
-      if attributes.has_key?(:'title')
+      if attributes.key?(:'title')
         self.title = attributes[:'title']
+      else
+        self.title = nil
       end
 
-      if attributes.has_key?(:'privacy')
+      if attributes.key?(:'privacy')
         self.privacy = attributes[:'privacy']
+      else
+        self.privacy = 'private'
       end
 
-      if attributes.has_key?(:'user')
+      if attributes.key?(:'user')
         self.user = attributes[:'user']
+      else
+        self.user = nil
       end
 
-      if attributes.has_key?(:'htmlUrl')
-        self.html_url = attributes[:'htmlUrl']
+      if attributes.key?(:'html_url')
+        self.html_url = attributes[:'html_url']
+      else
+        self.html_url = nil
       end
 
-      if attributes.has_key?(:'subtitle')
+      if attributes.key?(:'subtitle')
         self.subtitle = attributes[:'subtitle']
       end
 
-      if attributes.has_key?(:'lyricist')
+      if attributes.key?(:'lyricist')
         self.lyricist = attributes[:'lyricist']
       end
 
-      if attributes.has_key?(:'composer')
+      if attributes.key?(:'arranger')
+        self.arranger = attributes[:'arranger']
+      end
+
+      if attributes.key?(:'composer')
         self.composer = attributes[:'composer']
       end
 
-      if attributes.has_key?(:'description')
+      if attributes.key?(:'description')
         self.description = attributes[:'description']
       end
 
-      if attributes.has_key?(:'tags')
+      if attributes.key?(:'tags')
         if (value = attributes[:'tags']).is_a?(Array)
           self.tags = value
         end
       end
 
-      if attributes.has_key?(:'creationType')
-        self.creation_type = attributes[:'creationType']
+      if attributes.key?(:'creation_type')
+        self.creation_type = attributes[:'creation_type']
       end
 
-      if attributes.has_key?(:'license')
+      if attributes.key?(:'license')
         self.license = attributes[:'license']
       end
 
-      if attributes.has_key?(:'licenseText')
-        self.license_text = attributes[:'licenseText']
+      if attributes.key?(:'license_text')
+        self.license_text = attributes[:'license_text']
+      end
+
+      if attributes.key?(:'duration_time')
+        self.duration_time = attributes[:'duration_time']
       end
 
-      if attributes.has_key?(:'durationTime')
-        self.duration_time = attributes[:'durationTime']
+      if attributes.key?(:'number_measures')
+        self.number_measures = attributes[:'number_measures']
       end
 
-      if attributes.has_key?(:'numberMeasures')
-        self.number_measures = attributes[:'numberMeasures']
+      if attributes.key?(:'main_tempo_qpm')
+        self.main_tempo_qpm = attributes[:'main_tempo_qpm']
       end
 
-      if attributes.has_key?(:'mainTempoQpm')
-        self.main_tempo_qpm = attributes[:'mainTempoQpm']
+      if attributes.key?(:'main_key_signature')
+        self.main_key_signature = attributes[:'main_key_signature']
       end
 
-      if attributes.has_key?(:'rights')
+      if attributes.key?(:'rights')
         self.rights = attributes[:'rights']
+      else
+        self.rights = nil
       end
 
-      if attributes.has_key?(:'collaborators')
+      if attributes.key?(:'collaborators')
         if (value = attributes[:'collaborators']).is_a?(Array)
           self.collaborators = value
         end
+      else
+        self.collaborators = nil
       end
 
-      if attributes.has_key?(:'creationDate')
-        self.creation_date = attributes[:'creationDate']
+      if attributes.key?(:'creation_date')
+        self.creation_date = attributes[:'creation_date']
+      else
+        self.creation_date = nil
       end
 
-      if attributes.has_key?(:'modificationDate')
-        self.modification_date = attributes[:'modificationDate']
+      if attributes.key?(:'modification_date')
+        self.modification_date = attributes[:'modification_date']
       end
 
-      if attributes.has_key?(:'publicationDate')
-        self.publication_date = attributes[:'publicationDate']
+      if attributes.key?(:'publication_date')
+        self.publication_date = attributes[:'publication_date']
       end
 
-      if attributes.has_key?(:'organization')
+      if attributes.key?(:'highlighted_date')
+        self.highlighted_date = attributes[:'highlighted_date']
+      end
+
+      if attributes.key?(:'organization')
         self.organization = attributes[:'organization']
       end
 
-      if attributes.has_key?(:'parentScore')
-        self.parent_score = attributes[:'parentScore']
+      if attributes.key?(:'parent_score')
+        self.parent_score = attributes[:'parent_score']
       end
 
-      if attributes.has_key?(:'instruments')
+      if attributes.key?(:'instruments')
         if (value = attributes[:'instruments']).is_a?(Array)
           self.instruments = value
         end
+      else
+        self.instruments = nil
       end
 
-      if attributes.has_key?(:'googleDriveFileId')
-        self.google_drive_file_id = attributes[:'googleDriveFileId']
+      if attributes.key?(:'samples')
+        if (value = attributes[:'samples']).is_a?(Array)
+          self.samples = value
+        end
+      else
+        self.samples = nil
       end
 
-      if attributes.has_key?(:'likes')
+      if attributes.key?(:'google_drive_file_id')
+        self.google_drive_file_id = attributes[:'google_drive_file_id']
+      end
+
+      if attributes.key?(:'likes')
         self.likes = attributes[:'likes']
       end
 
-      if attributes.has_key?(:'comments')
+      if attributes.key?(:'comments')
         self.comments = attributes[:'comments']
       end
 
-      if attributes.has_key?(:'views')
+      if attributes.key?(:'views')
         self.views = attributes[:'views']
       end
 
+      if attributes.key?(:'plays')
+        self.plays = attributes[:'plays']
+      end
+
+      if attributes.key?(:'collections')
+        if (value = attributes[:'collections']).is_a?(Array)
+          self.collections = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      return invalid_properties
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @privacy.nil?
+        invalid_properties.push('invalid value for "privacy", privacy cannot be nil.')
+      end
+
+      if @user.nil?
+        invalid_properties.push('invalid value for "user", user cannot be nil.')
+      end
+
+      if @html_url.nil?
+        invalid_properties.push('invalid value for "html_url", html_url cannot be nil.')
+      end
+
+      if @rights.nil?
+        invalid_properties.push('invalid value for "rights", rights cannot be nil.')
+      end
+
+      if @collaborators.nil?
+        invalid_properties.push('invalid value for "collaborators", collaborators cannot be nil.')
+      end
+
+      if @creation_date.nil?
+        invalid_properties.push('invalid value for "creation_date", creation_date cannot be nil.')
+      end
+
+      if @instruments.nil?
+        invalid_properties.push('invalid value for "instruments", instruments cannot be nil.')
+      end
+
+      if @samples.nil?
+        invalid_properties.push('invalid value for "samples", samples cannot be nil.')
+      end
+
+      invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return true
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
+      return false if @title.nil?
+      return false if @privacy.nil?
+      return false if @user.nil?
+      return false if @html_url.nil?
+      return false if @rights.nil?
+      return false if @collaborators.nil?
+      return false if @creation_date.nil?
+      return false if @instruments.nil?
+      return false if @samples.nil?
+      true
     end
 
     # Checks equality by comparing each attribute.
@@ -323,6 +500,7 @@ module FlatApi
           html_url == o.html_url &&
           subtitle == o.subtitle &&
           lyricist == o.lyricist &&
+          arranger == o.arranger &&
           composer == o.composer &&
           description == o.description &&
           tags == o.tags &&
@@ -332,18 +510,23 @@ module FlatApi
           duration_time == o.duration_time &&
           number_measures == o.number_measures &&
           main_tempo_qpm == o.main_tempo_qpm &&
+          main_key_signature == o.main_key_signature &&
           rights == o.rights &&
           collaborators == o.collaborators &&
           creation_date == o.creation_date &&
           modification_date == o.modification_date &&
           publication_date == o.publication_date &&
+          highlighted_date == o.highlighted_date &&
           organization == o.organization &&
           parent_score == o.parent_score &&
           instruments == o.instruments &&
+          samples == o.samples &&
           google_drive_file_id == o.google_drive_file_id &&
           likes == o.likes &&
           comments == o.comments &&
-          views == o.views
+          views == o.views &&
+          plays == o.plays &&
+          collections == o.collections
     end
 
     # @see the `==` method
@@ -353,39 +536,42 @@ module FlatApi
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     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
+      [id, sharing_key, title, privacy, user, html_url, subtitle, lyricist, arranger, composer, description, tags, creation_type, license, license_text, duration_time, number_measures, main_tempo_qpm, main_key_signature, rights, collaborators, creation_date, modification_date, publication_date, highlighted_date, organization, parent_score, instruments, samples, google_drive_file_id, likes, comments, views, plays, collections].hash
     end
 
     # Builds the object from hash
     # @param [Hash] attributes Model attributes in the form of hash
     # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
+    def self.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
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that 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) } )
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
       end
-
-      self
+      new(transformed_hash)
     end
 
     # Deserializes the data based on type
     # @param string type Data type
     # @param string value Value to be deserialized
     # @return [Object] Deserialized data
-    def _deserialize(type, value)
+    def self._deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -394,7 +580,7 @@ module FlatApi
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -415,8 +601,9 @@ module FlatApi
           end
         end
       else # model
-        temp_model = FlatApi.const_get(type).new
-        temp_model.build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = FlatApi.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -438,7 +625,11 @@ module FlatApi
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
         hash[param] = _to_hash(value)
       end
       hash
@@ -450,7 +641,7 @@ module FlatApi
     # @return [Hash] Returns the value in the form of hash
     def _to_hash(value)
       if value.is_a?(Array)
-        value.compact.map{ |v| _to_hash(v) }
+        value.compact.map { |v| _to_hash(v) }
       elsif value.is_a?(Hash)
         {}.tap do |hash|
           value.each { |k, v| hash[k] = _to_hash(v) }