songtradr_api_client_ruby 1.12.21

data/lib/songtradr_api_client_ruby/models/file_dto.rb

@@ -0,0 +1,450 @@
+=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: 7.0.0-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module SongtradrApiClientRuby
+  # Details on a file that has been uploaded for auto-tagging or audio-recognition purposes.
+  class FileDTO
+    attr_accessor :id
+
+    attr_accessor :name
+
+    attr_accessor :object_key
+
+    attr_accessor :folder
+
+    # extension of the file
+    attr_accessor :extension
+
+    attr_accessor :url
+
+    attr_accessor :upload_start_time
+
+    attr_accessor :upload_end_time
+
+    # status of the audio recognition
+    attr_accessor :fingerprint_status
+
+    attr_accessor :fingerprint_start_time
+
+    attr_accessor :fingerprint_end_time
+
+    # status of the auto-tagging
+    attr_accessor :inference_status
+
+    attr_accessor :inference_start_time
+
+    attr_accessor :inference_end_time
+
+    attr_accessor :recording
+
+    attr_accessor :error_time
+
+    attr_accessor :error_message
+
+    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',
+        :'name' => :'name',
+        :'object_key' => :'objectKey',
+        :'folder' => :'folder',
+        :'extension' => :'extension',
+        :'url' => :'url',
+        :'upload_start_time' => :'uploadStartTime',
+        :'upload_end_time' => :'uploadEndTime',
+        :'fingerprint_status' => :'fingerprintStatus',
+        :'fingerprint_start_time' => :'fingerprintStartTime',
+        :'fingerprint_end_time' => :'fingerprintEndTime',
+        :'inference_status' => :'inferenceStatus',
+        :'inference_start_time' => :'inferenceStartTime',
+        :'inference_end_time' => :'inferenceEndTime',
+        :'recording' => :'recording',
+        :'error_time' => :'error_time',
+        :'error_message' => :'error_message'
+      }
+    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',
+        :'name' => :'String',
+        :'object_key' => :'String',
+        :'folder' => :'String',
+        :'extension' => :'String',
+        :'url' => :'String',
+        :'upload_start_time' => :'Time',
+        :'upload_end_time' => :'Time',
+        :'fingerprint_status' => :'String',
+        :'fingerprint_start_time' => :'Time',
+        :'fingerprint_end_time' => :'Time',
+        :'inference_status' => :'String',
+        :'inference_start_time' => :'Time',
+        :'inference_end_time' => :'Time',
+        :'recording' => :'RecordingMediumDTO',
+        :'error_time' => :'Time',
+        :'error_message' => :'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 `SongtradrApiClientRuby::FileDTO` 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::FileDTO`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'object_key')
+        self.object_key = attributes[:'object_key']
+      end
+
+      if attributes.key?(:'folder')
+        self.folder = attributes[:'folder']
+      end
+
+      if attributes.key?(:'extension')
+        self.extension = attributes[:'extension']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'upload_start_time')
+        self.upload_start_time = attributes[:'upload_start_time']
+      end
+
+      if attributes.key?(:'upload_end_time')
+        self.upload_end_time = attributes[:'upload_end_time']
+      end
+
+      if attributes.key?(:'fingerprint_status')
+        self.fingerprint_status = attributes[:'fingerprint_status']
+      end
+
+      if attributes.key?(:'fingerprint_start_time')
+        self.fingerprint_start_time = attributes[:'fingerprint_start_time']
+      end
+
+      if attributes.key?(:'fingerprint_end_time')
+        self.fingerprint_end_time = attributes[:'fingerprint_end_time']
+      end
+
+      if attributes.key?(:'inference_status')
+        self.inference_status = attributes[:'inference_status']
+      end
+
+      if attributes.key?(:'inference_start_time')
+        self.inference_start_time = attributes[:'inference_start_time']
+      end
+
+      if attributes.key?(:'inference_end_time')
+        self.inference_end_time = attributes[:'inference_end_time']
+      end
+
+      if attributes.key?(:'recording')
+        self.recording = attributes[:'recording']
+      end
+
+      if attributes.key?(:'error_time')
+        self.error_time = attributes[:'error_time']
+      end
+
+      if attributes.key?(:'error_message')
+        self.error_message = attributes[:'error_message']
+      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
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @object_key.nil?
+        invalid_properties.push('invalid value for "object_key", object_key cannot be nil.')
+      end
+
+      if @folder.nil?
+        invalid_properties.push('invalid value for "folder", folder cannot be nil.')
+      end
+
+      if @extension.nil?
+        invalid_properties.push('invalid value for "extension", extension 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 false if @id.nil?
+      return false if @name.nil?
+      return false if @object_key.nil?
+      return false if @folder.nil?
+      return false if @extension.nil?
+      extension_validator = EnumAttributeValidator.new('String', ["mp3", "wav", "flac"])
+      return false unless extension_validator.valid?(@extension)
+      fingerprint_status_validator = EnumAttributeValidator.new('String', ["processing", "error", "found", "not_found", "not_started"])
+      return false unless fingerprint_status_validator.valid?(@fingerprint_status)
+      inference_status_validator = EnumAttributeValidator.new('String', ["processing", "error", "done", "not_started"])
+      return false unless inference_status_validator.valid?(@inference_status)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] extension Object to be assigned
+    def extension=(extension)
+      validator = EnumAttributeValidator.new('String', ["mp3", "wav", "flac"])
+      unless validator.valid?(extension)
+        fail ArgumentError, "invalid value for \"extension\", must be one of #{validator.allowable_values}."
+      end
+      @extension = extension
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] fingerprint_status Object to be assigned
+    def fingerprint_status=(fingerprint_status)
+      validator = EnumAttributeValidator.new('String', ["processing", "error", "found", "not_found", "not_started"])
+      unless validator.valid?(fingerprint_status)
+        fail ArgumentError, "invalid value for \"fingerprint_status\", must be one of #{validator.allowable_values}."
+      end
+      @fingerprint_status = fingerprint_status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] inference_status Object to be assigned
+    def inference_status=(inference_status)
+      validator = EnumAttributeValidator.new('String', ["processing", "error", "done", "not_started"])
+      unless validator.valid?(inference_status)
+        fail ArgumentError, "invalid value for \"inference_status\", must be one of #{validator.allowable_values}."
+      end
+      @inference_status = inference_status
+    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 &&
+          name == o.name &&
+          object_key == o.object_key &&
+          folder == o.folder &&
+          extension == o.extension &&
+          url == o.url &&
+          upload_start_time == o.upload_start_time &&
+          upload_end_time == o.upload_end_time &&
+          fingerprint_status == o.fingerprint_status &&
+          fingerprint_start_time == o.fingerprint_start_time &&
+          fingerprint_end_time == o.fingerprint_end_time &&
+          inference_status == o.inference_status &&
+          inference_start_time == o.inference_start_time &&
+          inference_end_time == o.inference_end_time &&
+          recording == o.recording &&
+          error_time == o.error_time &&
+          error_message == o.error_message
+    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, name, object_key, folder, extension, url, upload_start_time, upload_end_time, fingerprint_status, fingerprint_start_time, fingerprint_end_time, inference_status, inference_start_time, inference_end_time, recording, error_time, error_message].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 = 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