musicube_api_client_ruby 1.1.5

data/lib/musicube_api_client_ruby/models/save_taggrams_dto.rb

@@ -0,0 +1,574 @@
+=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.21
+Contact: info@songtradr.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
+
+=end
+
+require 'date'
+require 'time'
+
+module MusicubeApiClientRuby
+  # Timeseries of tags.
+  class SaveTaggramsDTO
+    attr_accessor :timestamps
+
+    attr_accessor :level1_genre
+
+    attr_accessor :level2_genre
+
+    attr_accessor :song_rating
+
+    attr_accessor :performance_rating
+
+    attr_accessor :production_rating
+
+    attr_accessor :mood_cluster
+
+    attr_accessor :vocals
+
+    attr_accessor :dominant_instrument
+
+    attr_accessor :sound_generation
+
+    attr_accessor :rhythm
+
+    attr_accessor :tonality
+
+    attr_accessor :audience_age
+
+    attr_accessor :audience_gender
+
+    attr_accessor :audience_region
+
+    attr_accessor :origin_region
+
+    attr_accessor :origin_decade
+
+    attr_accessor :language_of_performance
+
+    attr_accessor :arousal
+
+    attr_accessor :valence
+
+    attr_accessor :pleasantness
+
+    attr_accessor :engagement
+
+    attr_accessor :energy
+
+    attr_accessor :timbre
+
+    attr_accessor :roughness
+
+    attr_accessor :harmony
+
+    attr_accessor :texture
+
+    attr_accessor :groovyness
+
+    attr_accessor :space
+
+    attr_accessor :curateability
+
+    attr_accessor :use_case
+
+    attr_accessor :social_media
+
+    attr_accessor :industry_suitability
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'timestamps' => :'timestamps',
+        :'level1_genre' => :'level1Genre',
+        :'level2_genre' => :'level2Genre',
+        :'song_rating' => :'songRating',
+        :'performance_rating' => :'performanceRating',
+        :'production_rating' => :'productionRating',
+        :'mood_cluster' => :'moodCluster',
+        :'vocals' => :'vocals',
+        :'dominant_instrument' => :'dominantInstrument',
+        :'sound_generation' => :'soundGeneration',
+        :'rhythm' => :'rhythm',
+        :'tonality' => :'tonality',
+        :'audience_age' => :'audienceAge',
+        :'audience_gender' => :'audienceGender',
+        :'audience_region' => :'audienceRegion',
+        :'origin_region' => :'originRegion',
+        :'origin_decade' => :'originDecade',
+        :'language_of_performance' => :'languageOfPerformance',
+        :'arousal' => :'arousal',
+        :'valence' => :'valence',
+        :'pleasantness' => :'pleasantness',
+        :'engagement' => :'engagement',
+        :'energy' => :'energy',
+        :'timbre' => :'timbre',
+        :'roughness' => :'roughness',
+        :'harmony' => :'harmony',
+        :'texture' => :'texture',
+        :'groovyness' => :'groovyness',
+        :'space' => :'space',
+        :'curateability' => :'curateability',
+        :'use_case' => :'useCase',
+        :'social_media' => :'socialMedia',
+        :'industry_suitability' => :'industrySuitability'
+      }
+    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
+      {
+        :'timestamps' => :'Array<Float>',
+        :'level1_genre' => :'Hash<String, Array<Float>>',
+        :'level2_genre' => :'Hash<String, Array<Float>>',
+        :'song_rating' => :'Hash<String, Array<Float>>',
+        :'performance_rating' => :'Hash<String, Array<Float>>',
+        :'production_rating' => :'Hash<String, Array<Float>>',
+        :'mood_cluster' => :'Hash<String, Array<Float>>',
+        :'vocals' => :'Hash<String, Array<Float>>',
+        :'dominant_instrument' => :'Hash<String, Array<Float>>',
+        :'sound_generation' => :'Hash<String, Array<Float>>',
+        :'rhythm' => :'Hash<String, Array<Float>>',
+        :'tonality' => :'Hash<String, Array<Float>>',
+        :'audience_age' => :'Hash<String, Array<Float>>',
+        :'audience_gender' => :'Hash<String, Array<Float>>',
+        :'audience_region' => :'Hash<String, Array<Float>>',
+        :'origin_region' => :'Hash<String, Array<Float>>',
+        :'origin_decade' => :'Hash<String, Array<Float>>',
+        :'language_of_performance' => :'Hash<String, Array<Float>>',
+        :'arousal' => :'Hash<String, Array<Float>>',
+        :'valence' => :'Hash<String, Array<Float>>',
+        :'pleasantness' => :'Hash<String, Array<Float>>',
+        :'engagement' => :'Hash<String, Array<Float>>',
+        :'energy' => :'Hash<String, Array<Float>>',
+        :'timbre' => :'Hash<String, Array<Float>>',
+        :'roughness' => :'Hash<String, Array<Float>>',
+        :'harmony' => :'Hash<String, Array<Float>>',
+        :'texture' => :'Hash<String, Array<Float>>',
+        :'groovyness' => :'Hash<String, Array<Float>>',
+        :'space' => :'Hash<String, Array<Float>>',
+        :'curateability' => :'Hash<String, Array<Float>>',
+        :'use_case' => :'Hash<String, Array<Float>>',
+        :'social_media' => :'Hash<String, Array<Float>>',
+        :'industry_suitability' => :'Hash<String, Array<Float>>'
+      }
+    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 `MusicubeApiClientRuby::SaveTaggramsDTO` 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 `MusicubeApiClientRuby::SaveTaggramsDTO`. 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?(:'timestamps')
+        if (value = attributes[:'timestamps']).is_a?(Array)
+          self.timestamps = value
+        end
+      end
+
+      if attributes.key?(:'level1_genre')
+        if (value = attributes[:'level1_genre']).is_a?(Hash)
+          self.level1_genre = value
+        end
+      end
+
+      if attributes.key?(:'level2_genre')
+        if (value = attributes[:'level2_genre']).is_a?(Hash)
+          self.level2_genre = value
+        end
+      end
+
+      if attributes.key?(:'song_rating')
+        if (value = attributes[:'song_rating']).is_a?(Hash)
+          self.song_rating = value
+        end
+      end
+
+      if attributes.key?(:'performance_rating')
+        if (value = attributes[:'performance_rating']).is_a?(Hash)
+          self.performance_rating = value
+        end
+      end
+
+      if attributes.key?(:'production_rating')
+        if (value = attributes[:'production_rating']).is_a?(Hash)
+          self.production_rating = value
+        end
+      end
+
+      if attributes.key?(:'mood_cluster')
+        if (value = attributes[:'mood_cluster']).is_a?(Hash)
+          self.mood_cluster = value
+        end
+      end
+
+      if attributes.key?(:'vocals')
+        if (value = attributes[:'vocals']).is_a?(Hash)
+          self.vocals = value
+        end
+      end
+
+      if attributes.key?(:'dominant_instrument')
+        if (value = attributes[:'dominant_instrument']).is_a?(Hash)
+          self.dominant_instrument = value
+        end
+      end
+
+      if attributes.key?(:'sound_generation')
+        if (value = attributes[:'sound_generation']).is_a?(Hash)
+          self.sound_generation = value
+        end
+      end
+
+      if attributes.key?(:'rhythm')
+        if (value = attributes[:'rhythm']).is_a?(Hash)
+          self.rhythm = value
+        end
+      end
+
+      if attributes.key?(:'tonality')
+        if (value = attributes[:'tonality']).is_a?(Hash)
+          self.tonality = value
+        end
+      end
+
+      if attributes.key?(:'audience_age')
+        if (value = attributes[:'audience_age']).is_a?(Hash)
+          self.audience_age = value
+        end
+      end
+
+      if attributes.key?(:'audience_gender')
+        if (value = attributes[:'audience_gender']).is_a?(Hash)
+          self.audience_gender = value
+        end
+      end
+
+      if attributes.key?(:'audience_region')
+        if (value = attributes[:'audience_region']).is_a?(Hash)
+          self.audience_region = value
+        end
+      end
+
+      if attributes.key?(:'origin_region')
+        if (value = attributes[:'origin_region']).is_a?(Hash)
+          self.origin_region = value
+        end
+      end
+
+      if attributes.key?(:'origin_decade')
+        if (value = attributes[:'origin_decade']).is_a?(Hash)
+          self.origin_decade = value
+        end
+      end
+
+      if attributes.key?(:'language_of_performance')
+        if (value = attributes[:'language_of_performance']).is_a?(Hash)
+          self.language_of_performance = value
+        end
+      end
+
+      if attributes.key?(:'arousal')
+        if (value = attributes[:'arousal']).is_a?(Hash)
+          self.arousal = value
+        end
+      end
+
+      if attributes.key?(:'valence')
+        if (value = attributes[:'valence']).is_a?(Hash)
+          self.valence = value
+        end
+      end
+
+      if attributes.key?(:'pleasantness')
+        if (value = attributes[:'pleasantness']).is_a?(Hash)
+          self.pleasantness = value
+        end
+      end
+
+      if attributes.key?(:'engagement')
+        if (value = attributes[:'engagement']).is_a?(Hash)
+          self.engagement = value
+        end
+      end
+
+      if attributes.key?(:'energy')
+        if (value = attributes[:'energy']).is_a?(Hash)
+          self.energy = value
+        end
+      end
+
+      if attributes.key?(:'timbre')
+        if (value = attributes[:'timbre']).is_a?(Hash)
+          self.timbre = value
+        end
+      end
+
+      if attributes.key?(:'roughness')
+        if (value = attributes[:'roughness']).is_a?(Hash)
+          self.roughness = value
+        end
+      end
+
+      if attributes.key?(:'harmony')
+        if (value = attributes[:'harmony']).is_a?(Hash)
+          self.harmony = value
+        end
+      end
+
+      if attributes.key?(:'texture')
+        if (value = attributes[:'texture']).is_a?(Hash)
+          self.texture = value
+        end
+      end
+
+      if attributes.key?(:'groovyness')
+        if (value = attributes[:'groovyness']).is_a?(Hash)
+          self.groovyness = value
+        end
+      end
+
+      if attributes.key?(:'space')
+        if (value = attributes[:'space']).is_a?(Hash)
+          self.space = value
+        end
+      end
+
+      if attributes.key?(:'curateability')
+        if (value = attributes[:'curateability']).is_a?(Hash)
+          self.curateability = value
+        end
+      end
+
+      if attributes.key?(:'use_case')
+        if (value = attributes[:'use_case']).is_a?(Hash)
+          self.use_case = value
+        end
+      end
+
+      if attributes.key?(:'social_media')
+        if (value = attributes[:'social_media']).is_a?(Hash)
+          self.social_media = value
+        end
+      end
+
+      if attributes.key?(:'industry_suitability')
+        if (value = attributes[:'industry_suitability']).is_a?(Hash)
+          self.industry_suitability = value
+        end
+      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
+      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?
+      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 &&
+          timestamps == o.timestamps &&
+          level1_genre == o.level1_genre &&
+          level2_genre == o.level2_genre &&
+          song_rating == o.song_rating &&
+          performance_rating == o.performance_rating &&
+          production_rating == o.production_rating &&
+          mood_cluster == o.mood_cluster &&
+          vocals == o.vocals &&
+          dominant_instrument == o.dominant_instrument &&
+          sound_generation == o.sound_generation &&
+          rhythm == o.rhythm &&
+          tonality == o.tonality &&
+          audience_age == o.audience_age &&
+          audience_gender == o.audience_gender &&
+          audience_region == o.audience_region &&
+          origin_region == o.origin_region &&
+          origin_decade == o.origin_decade &&
+          language_of_performance == o.language_of_performance &&
+          arousal == o.arousal &&
+          valence == o.valence &&
+          pleasantness == o.pleasantness &&
+          engagement == o.engagement &&
+          energy == o.energy &&
+          timbre == o.timbre &&
+          roughness == o.roughness &&
+          harmony == o.harmony &&
+          texture == o.texture &&
+          groovyness == o.groovyness &&
+          space == o.space &&
+          curateability == o.curateability &&
+          use_case == o.use_case &&
+          social_media == o.social_media &&
+          industry_suitability == o.industry_suitability
+    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
+      [timestamps, level1_genre, level2_genre, song_rating, performance_rating, production_rating, mood_cluster, vocals, dominant_instrument, sound_generation, rhythm, tonality, audience_age, audience_gender, audience_region, origin_region, origin_decade, language_of_performance, arousal, valence, pleasantness, engagement, energy, timbre, roughness, harmony, texture, groovyness, space, curateability, use_case, social_media, industry_suitability].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)
+      new.build_from_hash(attributes)
+    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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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
+      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 :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 = MusicubeApiClientRuby.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