flat_api 0.2.0 → 1.0.0

data/lib/flat_api/models/user_details_admin.rb

@@ -1,37 +1,49 @@
 =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
   # User details (view for organization teacher / admin)
-  class UserDetailsAdmin
+  class UserDetailsAdmin < ApiModelBase
     # The user unique identifier
     attr_accessor :id
 
+    # The type of user account
+    attr_accessor :type
+
+    attr_accessor :product
+
     # The user name (unique for the organization)
     attr_accessor :username
 
-    # A displayable name for the user
-    attr_accessor :name
-
-    # The name that can be directly printed (name or username)
+    # The name that can be directly printed (name, firstname & lastname, or username)
     attr_accessor :printable_name
 
-    # User pictue
+    # Firstname of the user (for education users)
+    attr_accessor :firstname
+
+    # Lastname of the user (for education users)
+    attr_accessor :lastname
+
+    # A displayable name for the user (for consumer users)
+    attr_accessor :name
+
+    # The URL of the picture to display
     attr_accessor :picture
 
-    # User license status. 'True' if user is an individual Power user
-    attr_accessor :is_power_user
+    # List of badges for the user profile:  - `power` - `staff` - `composerOfTheMonth` - `ambassador` - `challenge` 
+    attr_accessor :badges
 
     # Organization ID (for Edu users only)
     attr_accessor :organization
@@ -51,118 +63,304 @@ module FlatApi
 
     attr_accessor :license
 
+    # For Flat for Education accounts, list of Group identifiers the user is part of.
+    attr_accessor :groups
+
+    # Indicates if the user account is marked as a testing student account. Testing students are typically excluded from certain educational integrations and workflows. This field helps API clients distinguish between regular students and testing accounts. 
+    attr_accessor :is_edu_testing_student
+
+    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
       {
         :'id' => :'id',
+        :'type' => :'type',
+        :'product' => :'product',
         :'username' => :'username',
-        :'name' => :'name',
         :'printable_name' => :'printableName',
+        :'firstname' => :'firstname',
+        :'lastname' => :'lastname',
+        :'name' => :'name',
         :'picture' => :'picture',
-        :'is_power_user' => :'isPowerUser',
+        :'badges' => :'badges',
         :'organization' => :'organization',
         :'organization_role' => :'organizationRole',
         :'class_role' => :'classRole',
         :'html_url' => :'htmlUrl',
         :'email' => :'email',
         :'last_activity_date' => :'lastActivityDate',
-        :'license' => :'license'
+        :'license' => :'license',
+        :'groups' => :'groups',
+        :'is_edu_testing_student' => :'isEduTestingStudent'
       }
     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
       {
         :'id' => :'String',
+        :'type' => :'String',
+        :'product' => :'TutteoProduct',
         :'username' => :'String',
-        :'name' => :'String',
         :'printable_name' => :'String',
+        :'firstname' => :'String',
+        :'lastname' => :'String',
+        :'name' => :'String',
         :'picture' => :'String',
-        :'is_power_user' => :'BOOLEAN',
+        :'badges' => :'Array<String>',
         :'organization' => :'String',
         :'organization_role' => :'OrganizationRoles',
         :'class_role' => :'ClassRoles',
         :'html_url' => :'String',
         :'email' => :'String',
-        :'last_activity_date' => :'DateTime',
-        :'license' => :'UserDetailsAdminLicense'
+        :'last_activity_date' => :'Time',
+        :'license' => :'UserDetailsAdminAllOfLicense',
+        :'groups' => :'Array<String>',
+        :'is_edu_testing_student' => :'Boolean'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'UserPublicSummary'
+      ]
+    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::UserDetailsAdmin` 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
+      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::UserDetailsAdmin`. Please check the name to make sure it's valid. List of attributes: " + acceptable_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.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'product')
+        self.product = attributes[:'product']
+      else
+        self.product = 'flat'
       end
 
-      if attributes.has_key?(:'username')
+      if attributes.key?(:'username')
         self.username = attributes[:'username']
+      else
+        self.username = nil
       end
 
-      if attributes.has_key?(:'name')
-        self.name = attributes[:'name']
+      if attributes.key?(:'printable_name')
+        self.printable_name = attributes[:'printable_name']
+      end
+
+      if attributes.key?(:'firstname')
+        self.firstname = attributes[:'firstname']
       end
 
-      if attributes.has_key?(:'printableName')
-        self.printable_name = attributes[:'printableName']
+      if attributes.key?(:'lastname')
+        self.lastname = attributes[:'lastname']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
       end
 
-      if attributes.has_key?(:'picture')
+      if attributes.key?(:'picture')
         self.picture = attributes[:'picture']
+      else
+        self.picture = nil
       end
 
-      if attributes.has_key?(:'isPowerUser')
-        self.is_power_user = attributes[:'isPowerUser']
+      if attributes.key?(:'badges')
+        if (value = attributes[:'badges']).is_a?(Array)
+          self.badges = value
+        end
       end
 
-      if attributes.has_key?(:'organization')
+      if attributes.key?(:'organization')
         self.organization = attributes[:'organization']
       end
 
-      if attributes.has_key?(:'organizationRole')
-        self.organization_role = attributes[:'organizationRole']
+      if attributes.key?(:'organization_role')
+        self.organization_role = attributes[:'organization_role']
       end
 
-      if attributes.has_key?(:'classRole')
-        self.class_role = attributes[:'classRole']
+      if attributes.key?(:'class_role')
+        self.class_role = attributes[:'class_role']
       end
 
-      if attributes.has_key?(:'htmlUrl')
-        self.html_url = attributes[:'htmlUrl']
+      if attributes.key?(:'html_url')
+        self.html_url = attributes[:'html_url']
       end
 
-      if attributes.has_key?(:'email')
+      if attributes.key?(:'email')
         self.email = attributes[:'email']
       end
 
-      if attributes.has_key?(:'lastActivityDate')
-        self.last_activity_date = attributes[:'lastActivityDate']
+      if attributes.key?(:'last_activity_date')
+        self.last_activity_date = attributes[:'last_activity_date']
       end
 
-      if attributes.has_key?(:'license')
+      if attributes.key?(:'license')
         self.license = attributes[:'license']
       end
 
+      if attributes.key?(:'groups')
+        if (value = attributes[:'groups']).is_a?(Array)
+          self.groups = value
+        end
+      end
+
+      if attributes.key?(:'is_edu_testing_student')
+        self.is_edu_testing_student = attributes[:'is_edu_testing_student']
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @product.nil?
+        invalid_properties.push('invalid value for "product", product cannot be nil.')
+      end
+
+      if @username.nil?
+        invalid_properties.push('invalid value for "username", username cannot be nil.')
+      end
+
+      if @picture.nil?
+        invalid_properties.push('invalid value for "picture", picture 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 @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["user", "guest"])
+      return false unless type_validator.valid?(@type)
+      return false if @product.nil?
+      return false if @username.nil?
+      return false if @picture.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["user", "guest"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] product Value to be assigned
+    def product=(product)
+      if product.nil?
+        fail ArgumentError, 'product cannot be nil'
+      end
+
+      @product = product
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] username Value to be assigned
+    def username=(username)
+      if username.nil?
+        fail ArgumentError, 'username cannot be nil'
+      end
+
+      @username = username
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] picture Value to be assigned
+    def picture=(picture)
+      if picture.nil?
+        fail ArgumentError, 'picture cannot be nil'
+      end
+
+      @picture = picture
     end
 
     # Checks equality by comparing each attribute.
@@ -171,18 +369,24 @@ module FlatApi
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
+          type == o.type &&
+          product == o.product &&
           username == o.username &&
-          name == o.name &&
           printable_name == o.printable_name &&
+          firstname == o.firstname &&
+          lastname == o.lastname &&
+          name == o.name &&
           picture == o.picture &&
-          is_power_user == o.is_power_user &&
+          badges == o.badges &&
           organization == o.organization &&
           organization_role == o.organization_role &&
           class_role == o.class_role &&
           html_url == o.html_url &&
           email == o.email &&
           last_activity_date == o.last_activity_date &&
-          license == o.license
+          license == o.license &&
+          groups == o.groups &&
+          is_edu_testing_student == o.is_edu_testing_student
     end
 
     # @see the `==` method
@@ -192,83 +396,32 @@ module FlatApi
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [id, username, name, printable_name, picture, is_power_user, organization, organization_role, class_role, html_url, email, last_activity_date, license].hash
+      [id, type, product, username, printable_name, firstname, lastname, name, picture, badges, organization, organization_role, class_role, html_url, email, last_activity_date, license, groups, is_edu_testing_student].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
@@ -277,30 +430,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