songtradr_api_client_ruby 1.12.22 → 1.12.24

data/lib/songtradr_api_client_ruby/models/admin_api_user_dto.rb

@@ -0,0 +1,448 @@
+=begin
+#Songtradr API
+
+#This is the Songtradr API. Use it to retrieve deep music metadata and trigger processes like auto-tagging.  You can also use the API to manage your account and musicube cloud data.  **Authentication**  1. Reach out to support@songtradr.com to receive a free account or use your login data if you are already signed up.  2. To authenticate, you need to login via the POST /api/v1/user/login endpoint.  3. The endpoint responds with a jwtToken which you can use in all following API requests as a bearer token.  **Rate Limiting**  The current limit is 120 Requests per minute. Reach out to us via support@songtradr.com if you need to request more.  **Getting Started with auto-tagging**  1. If you want to get your own files auto-tagged, use the POST /api/v1/user/file/{name}/initUpload endpoint. It responds with a presigned S3 link where you can upload your file. 2. You can check the processing status of your file via the GET /api/v1/user/file/{name}/filesStatus endpoint. 3. As soon as processing is done, you can request the generated data via the GET /api/v1/user/files endpoint.  **Getting Started with search**  You can either search the released music via the /public/recording endpoints or your own private uploaded music via the /user/file/ endpoints.  1. If you want to search the world's released music, a good starting point is the GET /api/v1/public/recording/search endpoint. Please find the extensive list of parameters that serve as semantic search filters. 2. If you want to search your own previously uploaded music, a good starting point is the GET GET /api/v1/user/files endpoint. It has the same extensive list of parameters that serve as semantic search filters.
+
+The version of the OpenAPI document: 1.12.24
+Contact: info@songtradr.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 7.0.0-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module SongtradrApiClientRuby
+  class AdminApiUserDTO
+    attr_accessor :id
+
+    attr_accessor :username
+
+    attr_accessor :email
+
+    attr_accessor :full_name
+
+    attr_accessor :language
+
+    attr_accessor :is_admin
+
+    attr_accessor :widgets_allowed
+
+    attr_accessor :full_search_allowed
+
+    attr_accessor :voice_search_allowed
+
+    attr_accessor :recording_detail_allowed
+
+    attr_accessor :artist_detail_allowed
+
+    attr_accessor :playlist_prediction_allowed
+
+    attr_accessor :signup_allowed
+
+    attr_accessor :upload_allowed
+
+    attr_accessor :fingerprint_allowed
+
+    attr_accessor :audiotagging_allowed
+
+    attr_accessor :b2b_allowed
+
+    attr_accessor :editor_allowed
+
+    attr_accessor :reduced_musical_features
+
+    attr_accessor :confirmed
+
+    attr_accessor :gdpr_confirmation_timestamp
+
+    attr_accessor :last_login
+
+    attr_accessor :total_logins
+
+    attr_accessor :total_searches
+
+    attr_accessor :total_uploads
+
+    attr_accessor :total_downloads
+
+    attr_accessor :total_updates
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'username' => :'username',
+        :'email' => :'email',
+        :'full_name' => :'fullName',
+        :'language' => :'language',
+        :'is_admin' => :'isAdmin',
+        :'widgets_allowed' => :'widgetsAllowed',
+        :'full_search_allowed' => :'fullSearchAllowed',
+        :'voice_search_allowed' => :'voiceSearchAllowed',
+        :'recording_detail_allowed' => :'recordingDetailAllowed',
+        :'artist_detail_allowed' => :'artistDetailAllowed',
+        :'playlist_prediction_allowed' => :'playlistPredictionAllowed',
+        :'signup_allowed' => :'signupAllowed',
+        :'upload_allowed' => :'uploadAllowed',
+        :'fingerprint_allowed' => :'fingerprintAllowed',
+        :'audiotagging_allowed' => :'audiotaggingAllowed',
+        :'b2b_allowed' => :'b2bAllowed',
+        :'editor_allowed' => :'editorAllowed',
+        :'reduced_musical_features' => :'reducedMusicalFeatures',
+        :'confirmed' => :'confirmed',
+        :'gdpr_confirmation_timestamp' => :'gdprConfirmationTimestamp',
+        :'last_login' => :'lastLogin',
+        :'total_logins' => :'totalLogins',
+        :'total_searches' => :'totalSearches',
+        :'total_uploads' => :'totalUploads',
+        :'total_downloads' => :'totalDownloads',
+        :'total_updates' => :'totalUpdates'
+      }
+    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
+      {
+        :'id' => :'Integer',
+        :'username' => :'String',
+        :'email' => :'String',
+        :'full_name' => :'String',
+        :'language' => :'String',
+        :'is_admin' => :'Boolean',
+        :'widgets_allowed' => :'Boolean',
+        :'full_search_allowed' => :'Boolean',
+        :'voice_search_allowed' => :'Boolean',
+        :'recording_detail_allowed' => :'Boolean',
+        :'artist_detail_allowed' => :'Boolean',
+        :'playlist_prediction_allowed' => :'Boolean',
+        :'signup_allowed' => :'Boolean',
+        :'upload_allowed' => :'Boolean',
+        :'fingerprint_allowed' => :'Boolean',
+        :'audiotagging_allowed' => :'Boolean',
+        :'b2b_allowed' => :'Boolean',
+        :'editor_allowed' => :'Boolean',
+        :'reduced_musical_features' => :'Boolean',
+        :'confirmed' => :'Boolean',
+        :'gdpr_confirmation_timestamp' => :'Time',
+        :'last_login' => :'Time',
+        :'total_logins' => :'Integer',
+        :'total_searches' => :'Integer',
+        :'total_uploads' => :'Integer',
+        :'total_downloads' => :'Integer',
+        :'total_updates' => :'Integer'
+      }
+    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 `SongtradrApiClientRuby::AdminApiUserDTO` 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 `SongtradrApiClientRuby::AdminApiUserDTO`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'username')
+        self.username = attributes[:'username']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'full_name')
+        self.full_name = attributes[:'full_name']
+      end
+
+      if attributes.key?(:'language')
+        self.language = attributes[:'language']
+      end
+
+      if attributes.key?(:'is_admin')
+        self.is_admin = attributes[:'is_admin']
+      end
+
+      if attributes.key?(:'widgets_allowed')
+        self.widgets_allowed = attributes[:'widgets_allowed']
+      end
+
+      if attributes.key?(:'full_search_allowed')
+        self.full_search_allowed = attributes[:'full_search_allowed']
+      end
+
+      if attributes.key?(:'voice_search_allowed')
+        self.voice_search_allowed = attributes[:'voice_search_allowed']
+      end
+
+      if attributes.key?(:'recording_detail_allowed')
+        self.recording_detail_allowed = attributes[:'recording_detail_allowed']
+      end
+
+      if attributes.key?(:'artist_detail_allowed')
+        self.artist_detail_allowed = attributes[:'artist_detail_allowed']
+      end
+
+      if attributes.key?(:'playlist_prediction_allowed')
+        self.playlist_prediction_allowed = attributes[:'playlist_prediction_allowed']
+      end
+
+      if attributes.key?(:'signup_allowed')
+        self.signup_allowed = attributes[:'signup_allowed']
+      end
+
+      if attributes.key?(:'upload_allowed')
+        self.upload_allowed = attributes[:'upload_allowed']
+      end
+
+      if attributes.key?(:'fingerprint_allowed')
+        self.fingerprint_allowed = attributes[:'fingerprint_allowed']
+      end
+
+      if attributes.key?(:'audiotagging_allowed')
+        self.audiotagging_allowed = attributes[:'audiotagging_allowed']
+      end
+
+      if attributes.key?(:'b2b_allowed')
+        self.b2b_allowed = attributes[:'b2b_allowed']
+      end
+
+      if attributes.key?(:'editor_allowed')
+        self.editor_allowed = attributes[:'editor_allowed']
+      end
+
+      if attributes.key?(:'reduced_musical_features')
+        self.reduced_musical_features = attributes[:'reduced_musical_features']
+      end
+
+      if attributes.key?(:'confirmed')
+        self.confirmed = attributes[:'confirmed']
+      end
+
+      if attributes.key?(:'gdpr_confirmation_timestamp')
+        self.gdpr_confirmation_timestamp = attributes[:'gdpr_confirmation_timestamp']
+      end
+
+      if attributes.key?(:'last_login')
+        self.last_login = attributes[:'last_login']
+      end
+
+      if attributes.key?(:'total_logins')
+        self.total_logins = attributes[:'total_logins']
+      end
+
+      if attributes.key?(:'total_searches')
+        self.total_searches = attributes[:'total_searches']
+      end
+
+      if attributes.key?(:'total_uploads')
+        self.total_uploads = attributes[:'total_uploads']
+      end
+
+      if attributes.key?(:'total_downloads')
+        self.total_downloads = attributes[:'total_downloads']
+      end
+
+      if attributes.key?(:'total_updates')
+        self.total_updates = attributes[:'total_updates']
+      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
+      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'
+      true
+    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 &&
+          id == o.id &&
+          username == o.username &&
+          email == o.email &&
+          full_name == o.full_name &&
+          language == o.language &&
+          is_admin == o.is_admin &&
+          widgets_allowed == o.widgets_allowed &&
+          full_search_allowed == o.full_search_allowed &&
+          voice_search_allowed == o.voice_search_allowed &&
+          recording_detail_allowed == o.recording_detail_allowed &&
+          artist_detail_allowed == o.artist_detail_allowed &&
+          playlist_prediction_allowed == o.playlist_prediction_allowed &&
+          signup_allowed == o.signup_allowed &&
+          upload_allowed == o.upload_allowed &&
+          fingerprint_allowed == o.fingerprint_allowed &&
+          audiotagging_allowed == o.audiotagging_allowed &&
+          b2b_allowed == o.b2b_allowed &&
+          editor_allowed == o.editor_allowed &&
+          reduced_musical_features == o.reduced_musical_features &&
+          confirmed == o.confirmed &&
+          gdpr_confirmation_timestamp == o.gdpr_confirmation_timestamp &&
+          last_login == o.last_login &&
+          total_logins == o.total_logins &&
+          total_searches == o.total_searches &&
+          total_uploads == o.total_uploads &&
+          total_downloads == o.total_downloads &&
+          total_updates == o.total_updates
+    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
+      [id, username, email, full_name, language, is_admin, widgets_allowed, full_search_allowed, voice_search_allowed, recording_detail_allowed, artist_detail_allowed, playlist_prediction_allowed, signup_allowed, upload_allowed, fingerprint_allowed, audiotagging_allowed, b2b_allowed, editor_allowed, reduced_musical_features, confirmed, gdpr_confirmation_timestamp, last_login, total_logins, total_searches, total_uploads, total_downloads, total_updates].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 = SongtradrApiClientRuby.const_get(type)
+        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