flat_api 0.2.0 → 1.0.0

data/lib/flat_api/models/score_comment_context.rb

@@ -1,26 +1,30 @@
 =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, MuseScore, ABC notation, and many other formats * 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.26.1
 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
+Generator version: 7.24.0
 
 =end
 
 require 'date'
+require 'time'
 
 module FlatApi
   # The context of the comment (for inline/contextualized comments). A context will include all the information related to the location of the comment (i.e. score parts, range of measure, time position). 
-  class ScoreCommentContext
+  class ScoreCommentContext < ApiModelBase
     # The unique identifier (UUID) of the score part
     attr_accessor :part_uuid
 
-    # The identififer of the staff
+    # (Deprecated, use `staffUuid`) The identififer of the staff
     attr_accessor :staff_idx
 
+    # The unique identififer (UUID) of the staff
+    attr_accessor :staff_uuid
+
     # The list of measure UUIds
     attr_accessor :measure_uuids
 
@@ -32,12 +36,12 @@ module FlatApi
 
     attr_accessor :stop_dpq
 
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'part_uuid' => :'partUuid',
         :'staff_idx' => :'staffIdx',
+        :'staff_uuid' => :'staffUuid',
         :'measure_uuids' => :'measureUuids',
         :'start_time_pos' => :'startTimePos',
         :'stop_time_pos' => :'stopTimePos',
@@ -46,11 +50,22 @@ module FlatApi
       }
     end
 
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
         :'part_uuid' => :'String',
         :'staff_idx' => :'Float',
+        :'staff_uuid' => :'String',
         :'measure_uuids' => :'Array<String>',
         :'start_time_pos' => :'Float',
         :'stop_time_pos' => :'Float',
@@ -59,92 +74,178 @@ module FlatApi
       }
     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::ScoreCommentContext` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `FlatApi::ScoreCommentContext`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+      if attributes.key?(:'part_uuid')
+        self.part_uuid = attributes[:'part_uuid']
+      else
+        self.part_uuid = nil
+      end
 
-      if attributes.has_key?(:'partUuid')
-        self.part_uuid = attributes[:'partUuid']
+      if attributes.key?(:'staff_idx')
+        self.staff_idx = attributes[:'staff_idx']
       end
 
-      if attributes.has_key?(:'staffIdx')
-        self.staff_idx = attributes[:'staffIdx']
+      if attributes.key?(:'staff_uuid')
+        self.staff_uuid = attributes[:'staff_uuid']
       end
 
-      if attributes.has_key?(:'measureUuids')
-        if (value = attributes[:'measureUuids']).is_a?(Array)
+      if attributes.key?(:'measure_uuids')
+        if (value = attributes[:'measure_uuids']).is_a?(Array)
           self.measure_uuids = value
         end
+      else
+        self.measure_uuids = nil
       end
 
-      if attributes.has_key?(:'startTimePos')
-        self.start_time_pos = attributes[:'startTimePos']
+      if attributes.key?(:'start_time_pos')
+        self.start_time_pos = attributes[:'start_time_pos']
+      else
+        self.start_time_pos = nil
       end
 
-      if attributes.has_key?(:'stopTimePos')
-        self.stop_time_pos = attributes[:'stopTimePos']
+      if attributes.key?(:'stop_time_pos')
+        self.stop_time_pos = attributes[:'stop_time_pos']
+      else
+        self.stop_time_pos = nil
       end
 
-      if attributes.has_key?(:'startDpq')
-        self.start_dpq = attributes[:'startDpq']
+      if attributes.key?(:'start_dpq')
+        self.start_dpq = attributes[:'start_dpq']
+      else
+        self.start_dpq = nil
       end
 
-      if attributes.has_key?(:'stopDpq')
-        self.stop_dpq = attributes[:'stopDpq']
+      if attributes.key?(:'stop_dpq')
+        self.stop_dpq = attributes[:'stop_dpq']
+      else
+        self.stop_dpq = nil
       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
       if @part_uuid.nil?
-        invalid_properties.push("invalid value for 'part_uuid', part_uuid cannot be nil.")
-      end
-
-      if @staff_idx.nil?
-        invalid_properties.push("invalid value for 'staff_idx', staff_idx cannot be nil.")
+        invalid_properties.push('invalid value for "part_uuid", part_uuid cannot be nil.')
       end
 
       if @measure_uuids.nil?
-        invalid_properties.push("invalid value for 'measure_uuids', measure_uuids cannot be nil.")
+        invalid_properties.push('invalid value for "measure_uuids", measure_uuids cannot be nil.')
       end
 
       if @start_time_pos.nil?
-        invalid_properties.push("invalid value for 'start_time_pos', start_time_pos cannot be nil.")
+        invalid_properties.push('invalid value for "start_time_pos", start_time_pos cannot be nil.')
       end
 
       if @stop_time_pos.nil?
-        invalid_properties.push("invalid value for 'stop_time_pos', stop_time_pos cannot be nil.")
+        invalid_properties.push('invalid value for "stop_time_pos", stop_time_pos cannot be nil.')
       end
 
       if @start_dpq.nil?
-        invalid_properties.push("invalid value for 'start_dpq', start_dpq cannot be nil.")
+        invalid_properties.push('invalid value for "start_dpq", start_dpq cannot be nil.')
       end
 
       if @stop_dpq.nil?
-        invalid_properties.push("invalid value for 'stop_dpq', stop_dpq cannot be nil.")
+        invalid_properties.push('invalid value for "stop_dpq", stop_dpq cannot be nil.')
       end
 
-      return invalid_properties
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @part_uuid.nil?
-      return false if @staff_idx.nil?
       return false if @measure_uuids.nil?
       return false if @start_time_pos.nil?
       return false if @stop_time_pos.nil?
       return false if @start_dpq.nil?
       return false if @stop_dpq.nil?
-      return true
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] part_uuid Value to be assigned
+    def part_uuid=(part_uuid)
+      if part_uuid.nil?
+        fail ArgumentError, 'part_uuid cannot be nil'
+      end
+
+      @part_uuid = part_uuid
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] measure_uuids Value to be assigned
+    def measure_uuids=(measure_uuids)
+      if measure_uuids.nil?
+        fail ArgumentError, 'measure_uuids cannot be nil'
+      end
+
+      @measure_uuids = measure_uuids
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] start_time_pos Value to be assigned
+    def start_time_pos=(start_time_pos)
+      if start_time_pos.nil?
+        fail ArgumentError, 'start_time_pos cannot be nil'
+      end
+
+      @start_time_pos = start_time_pos
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] stop_time_pos Value to be assigned
+    def stop_time_pos=(stop_time_pos)
+      if stop_time_pos.nil?
+        fail ArgumentError, 'stop_time_pos cannot be nil'
+      end
+
+      @stop_time_pos = stop_time_pos
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] start_dpq Value to be assigned
+    def start_dpq=(start_dpq)
+      if start_dpq.nil?
+        fail ArgumentError, 'start_dpq cannot be nil'
+      end
+
+      @start_dpq = start_dpq
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] stop_dpq Value to be assigned
+    def stop_dpq=(stop_dpq)
+      if stop_dpq.nil?
+        fail ArgumentError, 'stop_dpq cannot be nil'
+      end
+
+      @stop_dpq = stop_dpq
     end
 
     # Checks equality by comparing each attribute.
@@ -154,6 +255,7 @@ module FlatApi
       self.class == o.class &&
           part_uuid == o.part_uuid &&
           staff_idx == o.staff_idx &&
+          staff_uuid == o.staff_uuid &&
           measure_uuids == o.measure_uuids &&
           start_time_pos == o.start_time_pos &&
           stop_time_pos == o.stop_time_pos &&
@@ -168,83 +270,32 @@ module FlatApi
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [part_uuid, staff_idx, measure_uuids, start_time_pos, stop_time_pos, start_dpq, stop_dpq].hash
+      [part_uuid, staff_idx, staff_uuid, measure_uuids, start_time_pos, stop_time_pos, start_dpq, stop_dpq].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) } )
-          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
-
-    # 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)
-      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)
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
           end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
-      else # model
-        temp_model = FlatApi.const_get(type).new
-        temp_model.build_from_hash(value)
       end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
+      new(transformed_hash)
     end
 
     # Returns the object in the form of hash
@@ -253,30 +304,16 @@ 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
     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
-    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
-
   end
 
 end