flat_api 0.1.2 → 0.3.5

data/lib/flat_api/models/{score_collaborator_creation.rb → resource_collaborator_creation.rb}

@@ -1,20 +1,21 @@
 =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.5.2
+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
-  # A collaborator of a score. The `userEmail` and `group` are only available if the requesting user is a collaborator of the related score (in this case these permissions will eventualy not be listed and exposed publicly). 
-  class ScoreCollaboratorCreation
+  # Add a collaborator to a resource.
+  class ResourceCollaboratorCreation
     # The unique identifier of a Flat user
     attr_accessor :user
 
@@ -24,6 +25,9 @@ module FlatApi
     # Fill this field to invite an individual user by email. 
     attr_accessor :user_email
 
+    # Token received in an invitation to join the score. 
+    attr_accessor :user_token
+
     # `True` if the related user can read the score. (probably true if the user has a permission on the document). 
     attr_accessor :acl_read
 
@@ -33,82 +37,106 @@ module FlatApi
     # `True` if the related user can can manage the current document, i.e. changing the document permissions and deleting the document 
     attr_accessor :acl_admin
 
-
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'user' => :'user',
         :'group' => :'group',
         :'user_email' => :'userEmail',
+        :'user_token' => :'userToken',
         :'acl_read' => :'aclRead',
         :'acl_write' => :'aclWrite',
         :'acl_admin' => :'aclAdmin'
       }
     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
       {
         :'user' => :'String',
         :'group' => :'String',
         :'user_email' => :'String',
-        :'acl_read' => :'BOOLEAN',
-        :'acl_write' => :'BOOLEAN',
-        :'acl_admin' => :'BOOLEAN'
+        :'user_token' => :'String',
+        :'acl_read' => :'Boolean',
+        :'acl_write' => :'Boolean',
+        :'acl_admin' => :'Boolean'
       }
     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::ResourceCollaboratorCreation` 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::ResourceCollaboratorCreation`. 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?(:'user')
+      if attributes.key?(:'user')
         self.user = attributes[:'user']
       end
 
-      if attributes.has_key?(:'group')
+      if attributes.key?(:'group')
         self.group = attributes[:'group']
       end
 
-      if attributes.has_key?(:'userEmail')
-        self.user_email = attributes[:'userEmail']
+      if attributes.key?(:'user_email')
+        self.user_email = attributes[:'user_email']
+      end
+
+      if attributes.key?(:'user_token')
+        self.user_token = attributes[:'user_token']
       end
 
-      if attributes.has_key?(:'aclRead')
-        self.acl_read = attributes[:'aclRead']
+      if attributes.key?(:'acl_read')
+        self.acl_read = attributes[:'acl_read']
       else
         self.acl_read = true
       end
 
-      if attributes.has_key?(:'aclWrite')
-        self.acl_write = attributes[:'aclWrite']
+      if attributes.key?(:'acl_write')
+        self.acl_write = attributes[:'acl_write']
       else
         self.acl_write = false
       end
 
-      if attributes.has_key?(:'aclAdmin')
-        self.acl_admin = attributes[:'aclAdmin']
+      if attributes.key?(:'acl_admin')
+        self.acl_admin = attributes[:'acl_admin']
       else
         self.acl_admin = false
       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
+      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'
+      true
     end
 
     # Checks equality by comparing each attribute.
@@ -119,6 +147,7 @@ module FlatApi
           user == o.user &&
           group == o.group &&
           user_email == o.user_email &&
+          user_token == o.user_token &&
           acl_read == o.acl_read &&
           acl_write == o.acl_write &&
           acl_admin == o.acl_admin
@@ -131,39 +160,42 @@ module FlatApi
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [user, group, user_email, acl_read, acl_write, acl_admin].hash
+      [user, group, user_email, user_token, acl_read, acl_write, acl_admin].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
@@ -172,7 +204,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
@@ -193,8 +225,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
 
@@ -216,7 +249,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
@@ -228,7 +265,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/resource_rights.rb

@@ -0,0 +1,318 @@
+=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, 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) 
+
+The version of the OpenAPI document: 2.20.0
+Contact: developers@flat.io
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.3.0
+
+=end
+
+require 'date'
+require 'time'
+
+module FlatApi
+  # The rights of the current user on a score or collection
+  class ResourceRights
+    # `True` if the current user can read the current document 
+    attr_accessor :acl_read
+
+    # `True` if the current user can modify the current document.  If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection. 
+    attr_accessor :acl_write
+
+    # `True` if the current user can manage the current document (i.e. share, delete)  If this is a right of a Collection, the capabilities of the associated user can be lower than this permission, check out the `capabilities` property as the end-user to have the complete possibilities with the collection. 
+    attr_accessor :acl_admin
+
+    # `True` if the current user is a collaborator of the current document (direct or via group). 
+    attr_accessor :is_collaborator
+
+    # The type of the collaborator for the resource 
+    attr_accessor :collaborator_type
+
+    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
+      {
+        :'acl_read' => :'aclRead',
+        :'acl_write' => :'aclWrite',
+        :'acl_admin' => :'aclAdmin',
+        :'is_collaborator' => :'isCollaborator',
+        :'collaborator_type' => :'collaboratorType'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'acl_read' => :'Boolean',
+        :'acl_write' => :'Boolean',
+        :'acl_admin' => :'Boolean',
+        :'is_collaborator' => :'Boolean',
+        :'collaborator_type' => :'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 = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `FlatApi::ResourceRights` initialize method"
+      end
+
+      # 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::ResourceRights`. 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.key?(:'acl_read')
+        self.acl_read = attributes[:'acl_read']
+      else
+        self.acl_read = false
+      end
+
+      if attributes.key?(:'acl_write')
+        self.acl_write = attributes[:'acl_write']
+      else
+        self.acl_write = false
+      end
+
+      if attributes.key?(:'acl_admin')
+        self.acl_admin = attributes[:'acl_admin']
+      else
+        self.acl_admin = false
+      end
+
+      if attributes.key?(:'is_collaborator')
+        self.is_collaborator = attributes[:'is_collaborator']
+      else
+        self.is_collaborator = false
+      end
+
+      if attributes.key?(:'collaborator_type')
+        self.collaborator_type = attributes[:'collaborator_type']
+      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 @acl_read.nil?
+        invalid_properties.push('invalid value for "acl_read", acl_read cannot be nil.')
+      end
+
+      if @acl_write.nil?
+        invalid_properties.push('invalid value for "acl_write", acl_write cannot be nil.')
+      end
+
+      if @acl_admin.nil?
+        invalid_properties.push('invalid value for "acl_admin", acl_admin cannot be nil.')
+      end
+
+      if @is_collaborator.nil?
+        invalid_properties.push('invalid value for "is_collaborator", is_collaborator 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @acl_read.nil?
+      return false if @acl_write.nil?
+      return false if @acl_admin.nil?
+      return false if @is_collaborator.nil?
+      collaborator_type_validator = EnumAttributeValidator.new('String', ["owner", "user", "group"])
+      return false unless collaborator_type_validator.valid?(@collaborator_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] collaborator_type Object to be assigned
+    def collaborator_type=(collaborator_type)
+      validator = EnumAttributeValidator.new('String', ["owner", "user", "group"])
+      unless validator.valid?(collaborator_type)
+        fail ArgumentError, "invalid value for \"collaborator_type\", must be one of #{validator.allowable_values}."
+      end
+      @collaborator_type = collaborator_type
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          acl_read == o.acl_read &&
+          acl_write == o.acl_write &&
+          acl_admin == o.acl_admin &&
+          is_collaborator == o.is_collaborator &&
+          collaborator_type == o.collaborator_type
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [acl_read, acl_write, acl_admin, is_collaborator, collaborator_type].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      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[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
+      end
+      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 self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # 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
+
+    # 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
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        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