flat_api 0.2.0 → 0.3.5

data/lib/flat_api/models/media_attachment.rb

@@ -1,21 +1,22 @@
 =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
   # Media attachment. The API will automatically resolve the details, oEmbed, and media available if possible and return them in this object 
   class MediaAttachment
-    # The type of the assignment resolved: * `rich`, `photo`, `video` are attachment types that are automatically resolved from a `link` attachment. * A `flat` attachment is a score document where the unique identifier will be specified in the `score` property. Its sharing mode will be provided in the `sharingMode` property. 
+    # The type of the assignment resolved: * `rich`, `photo`, `video` are automatically resolved as `link` * A `flat` attachment is a score document where the unique identifier will be specified in the `score` property. Its sharing mode will be provided in the `sharingMode` property. 
     attr_accessor :type
 
     # An unique Flat score identifier
@@ -24,11 +25,20 @@ module FlatApi
     # An unique revision identifier of a score
     attr_accessor :revision
 
-    # If the attachment is an exercise question, this state will describe if it is correct or not.For exercise assignments only.
-    attr_accessor :correct
+    # An unique worksheet identifier
+    attr_accessor :worksheet
+
+    # True if the resource is dedicated for the assignment (for scores and worksheets), meaning on the user-side this one is stored in the assignment
+    attr_accessor :dedicated
+
+    # A unique track identifier
+    attr_accessor :track
 
     attr_accessor :sharing_mode
 
+    # To be used with a score attached in `sharingMode` `copy` (score used as template). If true, students won't be able to change the original notes of the template.
+    attr_accessor :lock_score_template
+
     # The resolved title of the attachment
     attr_accessor :title
 
@@ -62,6 +72,15 @@ module FlatApi
     # The resolved author url of the attachment
     attr_accessor :author_url
 
+    # The URL of the icon
+    attr_accessor :icon_url
+
+    # The mine type of the file
+    attr_accessor :mime_type
+
+    # The ID of the Google Drive File
+    attr_accessor :google_drive_file_id
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -90,8 +109,11 @@ module FlatApi
         :'type' => :'type',
         :'score' => :'score',
         :'revision' => :'revision',
-        :'correct' => :'correct',
+        :'worksheet' => :'worksheet',
+        :'dedicated' => :'dedicated',
+        :'track' => :'track',
         :'sharing_mode' => :'sharingMode',
+        :'lock_score_template' => :'lockScoreTemplate',
         :'title' => :'title',
         :'description' => :'description',
         :'html' => :'html',
@@ -102,18 +124,29 @@ module FlatApi
         :'thumbnail_width' => :'thumbnailWidth',
         :'thumbnail_height' => :'thumbnailHeight',
         :'author_name' => :'authorName',
-        :'author_url' => :'authorUrl'
+        :'author_url' => :'authorUrl',
+        :'icon_url' => :'iconUrl',
+        :'mime_type' => :'mimeType',
+        :'google_drive_file_id' => :'googleDriveFileId'
       }
     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
       {
         :'type' => :'String',
         :'score' => :'String',
         :'revision' => :'String',
-        :'correct' => :'BOOLEAN',
+        :'worksheet' => :'String',
+        :'dedicated' => :'Boolean',
+        :'track' => :'String',
         :'sharing_mode' => :'MediaScoreSharingMode',
+        :'lock_score_template' => :'Boolean',
         :'title' => :'String',
         :'description' => :'String',
         :'html' => :'String',
@@ -121,108 +154,158 @@ module FlatApi
         :'html_height' => :'String',
         :'url' => :'String',
         :'thumbnail_url' => :'String',
-        :'thumbnail_width' => :'String',
-        :'thumbnail_height' => :'String',
+        :'thumbnail_width' => :'Integer',
+        :'thumbnail_height' => :'Integer',
         :'author_name' => :'String',
-        :'author_url' => :'String'
+        :'author_url' => :'String',
+        :'icon_url' => :'String',
+        :'mime_type' => :'String',
+        :'google_drive_file_id' => :'String'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::MediaAttachment` 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::MediaAttachment`. 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?(:'type')
+      if attributes.key?(:'type')
         self.type = attributes[:'type']
+      else
+        self.type = nil
       end
 
-      if attributes.has_key?(:'score')
+      if attributes.key?(:'score')
         self.score = attributes[:'score']
       end
 
-      if attributes.has_key?(:'revision')
+      if attributes.key?(:'revision')
         self.revision = attributes[:'revision']
       end
 
-      if attributes.has_key?(:'correct')
-        self.correct = attributes[:'correct']
+      if attributes.key?(:'worksheet')
+        self.worksheet = attributes[:'worksheet']
+      end
+
+      if attributes.key?(:'dedicated')
+        self.dedicated = attributes[:'dedicated']
       end
 
-      if attributes.has_key?(:'sharingMode')
-        self.sharing_mode = attributes[:'sharingMode']
+      if attributes.key?(:'track')
+        self.track = attributes[:'track']
       end
 
-      if attributes.has_key?(:'title')
+      if attributes.key?(:'sharing_mode')
+        self.sharing_mode = attributes[:'sharing_mode']
+      else
+        self.sharing_mode = 'read'
+      end
+
+      if attributes.key?(:'lock_score_template')
+        self.lock_score_template = attributes[:'lock_score_template']
+      end
+
+      if attributes.key?(:'title')
         self.title = attributes[:'title']
       end
 
-      if attributes.has_key?(:'description')
+      if attributes.key?(:'description')
         self.description = attributes[:'description']
       end
 
-      if attributes.has_key?(:'html')
+      if attributes.key?(:'html')
         self.html = attributes[:'html']
       end
 
-      if attributes.has_key?(:'htmlWidth')
-        self.html_width = attributes[:'htmlWidth']
+      if attributes.key?(:'html_width')
+        self.html_width = attributes[:'html_width']
       end
 
-      if attributes.has_key?(:'htmlHeight')
-        self.html_height = attributes[:'htmlHeight']
+      if attributes.key?(:'html_height')
+        self.html_height = attributes[:'html_height']
       end
 
-      if attributes.has_key?(:'url')
+      if attributes.key?(:'url')
         self.url = attributes[:'url']
       end
 
-      if attributes.has_key?(:'thumbnailUrl')
-        self.thumbnail_url = attributes[:'thumbnailUrl']
+      if attributes.key?(:'thumbnail_url')
+        self.thumbnail_url = attributes[:'thumbnail_url']
+      end
+
+      if attributes.key?(:'thumbnail_width')
+        self.thumbnail_width = attributes[:'thumbnail_width']
+      end
+
+      if attributes.key?(:'thumbnail_height')
+        self.thumbnail_height = attributes[:'thumbnail_height']
       end
 
-      if attributes.has_key?(:'thumbnailWidth')
-        self.thumbnail_width = attributes[:'thumbnailWidth']
+      if attributes.key?(:'author_name')
+        self.author_name = attributes[:'author_name']
       end
 
-      if attributes.has_key?(:'thumbnailHeight')
-        self.thumbnail_height = attributes[:'thumbnailHeight']
+      if attributes.key?(:'author_url')
+        self.author_url = attributes[:'author_url']
       end
 
-      if attributes.has_key?(:'authorName')
-        self.author_name = attributes[:'authorName']
+      if attributes.key?(:'icon_url')
+        self.icon_url = attributes[:'icon_url']
       end
 
-      if attributes.has_key?(:'authorUrl')
-        self.author_url = attributes[:'authorUrl']
+      if attributes.key?(:'mime_type')
+        self.mime_type = attributes[:'mime_type']
       end
 
+      if attributes.key?(:'google_drive_file_id')
+        self.google_drive_file_id = attributes[:'google_drive_file_id']
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type 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?
-      type_validator = EnumAttributeValidator.new('String', ["rich", "photo", "video", "link", "flat", "exercise"])
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["rich", "photo", "video", "link", "flat", "googleDrive", "worksheet", "performance"])
       return false unless type_validator.valid?(@type)
-      return true
+      true
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
-      validator = EnumAttributeValidator.new('String', ["rich", "photo", "video", "link", "flat", "exercise"])
+      validator = EnumAttributeValidator.new('String', ["rich", "photo", "video", "link", "flat", "googleDrive", "worksheet", "performance"])
       unless validator.valid?(type)
-        fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
       end
       @type = type
     end
@@ -235,8 +318,11 @@ module FlatApi
           type == o.type &&
           score == o.score &&
           revision == o.revision &&
-          correct == o.correct &&
+          worksheet == o.worksheet &&
+          dedicated == o.dedicated &&
+          track == o.track &&
           sharing_mode == o.sharing_mode &&
+          lock_score_template == o.lock_score_template &&
           title == o.title &&
           description == o.description &&
           html == o.html &&
@@ -247,7 +333,10 @@ module FlatApi
           thumbnail_width == o.thumbnail_width &&
           thumbnail_height == o.thumbnail_height &&
           author_name == o.author_name &&
-          author_url == o.author_url
+          author_url == o.author_url &&
+          icon_url == o.icon_url &&
+          mime_type == o.mime_type &&
+          google_drive_file_id == o.google_drive_file_id
     end
 
     # @see the `==` method
@@ -257,39 +346,42 @@ module FlatApi
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [type, score, revision, correct, sharing_mode, title, description, html, html_width, html_height, url, thumbnail_url, thumbnail_width, thumbnail_height, author_name, author_url].hash
+      [type, score, revision, worksheet, dedicated, track, sharing_mode, lock_score_template, title, description, html, html_width, html_height, url, thumbnail_url, thumbnail_width, thumbnail_height, author_name, author_url, icon_url, mime_type, google_drive_file_id].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
@@ -298,7 +390,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
@@ -319,8 +411,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
 
@@ -342,7 +435,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
@@ -354,7 +451,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) }

data/lib/flat_api/models/media_score_sharing_mode.rb

@@ -1,32 +1,42 @@
 =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
   class MediaScoreSharingMode
-    
     READ = "read".freeze
     WRITE = "write".freeze
     COPY = "copy".freeze
+    PERFORMANCE = "performance".freeze
+
+    def self.all_vars
+      @all_vars ||= [READ, WRITE, COPY, PERFORMANCE].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string
     # @return [String] The enum value
     def build_from_hash(value)
-      constantValues = MediaScoreSharingMode.constants.select{|c| MediaScoreSharingMode::const_get(c) == value}
-      raise "Invalid ENUM value #{value} for class #MediaScoreSharingMode" if constantValues.empty?
-      value
+      return value if MediaScoreSharingMode.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #MediaScoreSharingMode"
     end
   end
-
 end