spotify-api-sdk 1.0.0

data/lib/spotify_web_api/models/simplified_track_object.rb

@@ -0,0 +1,227 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # SimplifiedTrackObject Model.
+  class SimplifiedTrackObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The artists who performed the track. Each artist object includes a link in
+    # `href` to more detailed information about the artist.
+    # @return [Array[SimplifiedArtistObject]]
+    attr_accessor :artists
+
+    # A list of the countries in which the track can be played, identified by
+    # their [ISO 3166-1
+    # alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code.
+    # @return [Array[String]]
+    attr_accessor :available_markets
+
+    # The disc number (usually `1` unless the album consists of more than one
+    # disc).
+    # @return [Integer]
+    attr_accessor :disc_number
+
+    # The track length in milliseconds.
+    # @return [Integer]
+    attr_accessor :duration_ms
+
+    # Whether or not the track has explicit lyrics ( `true` = yes it does;
+    # `false` = no it does not OR unknown).
+    # @return [TrueClass | FalseClass]
+    attr_accessor :explicit
+
+    # External URLs for this track.
+    # @return [ExternalUrlObject]
+    attr_accessor :external_urls
+
+    # A link to the Web API endpoint providing full details of the track.
+    # @return [String]
+    attr_accessor :href
+
+    # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+    # track.
+    # @return [String]
+    attr_accessor :id
+
+    # Part of the response when [Track
+    # Relinking](/documentation/web-api/concepts/track-relinking/) is applied.
+    # If `true`, the track is playable in the given market. Otherwise `false`.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_playable
+
+    # Part of the response when [Track
+    # Relinking](/documentation/web-api/concepts/track-relinking/) is applied
+    # and is only part of the response if the track linking, in fact, exists.
+    # The requested track has been replaced with a different track. The track in
+    # the `linked_from` object contains information about the originally
+    # requested track.
+    # @return [LinkedTrackObject]
+    attr_accessor :linked_from
+
+    # Included in the response when a content restriction is applied.
+    # @return [TrackRestrictionObject]
+    attr_accessor :restrictions
+
+    # The name of the track.
+    # @return [String]
+    attr_accessor :name
+
+    # A URL to a 30 second preview (MP3 format) of the track.
+    # @return [String]
+    attr_accessor :preview_url
+
+    # The number of the track. If an album has several discs, the track number
+    # is the number on the specified disc.
+    # @return [Integer]
+    attr_accessor :track_number
+
+    # The object type: "track".
+    # @return [String]
+    attr_accessor :type
+
+    # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for
+    # the track.
+    # @return [String]
+    attr_accessor :uri
+
+    # Whether or not the track is from a local file.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_local
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['artists'] = 'artists'
+      @_hash['available_markets'] = 'available_markets'
+      @_hash['disc_number'] = 'disc_number'
+      @_hash['duration_ms'] = 'duration_ms'
+      @_hash['explicit'] = 'explicit'
+      @_hash['external_urls'] = 'external_urls'
+      @_hash['href'] = 'href'
+      @_hash['id'] = 'id'
+      @_hash['is_playable'] = 'is_playable'
+      @_hash['linked_from'] = 'linked_from'
+      @_hash['restrictions'] = 'restrictions'
+      @_hash['name'] = 'name'
+      @_hash['preview_url'] = 'preview_url'
+      @_hash['track_number'] = 'track_number'
+      @_hash['type'] = 'type'
+      @_hash['uri'] = 'uri'
+      @_hash['is_local'] = 'is_local'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        artists
+        available_markets
+        disc_number
+        duration_ms
+        explicit
+        external_urls
+        href
+        id
+        is_playable
+        linked_from
+        restrictions
+        name
+        preview_url
+        track_number
+        type
+        uri
+        is_local
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        preview_url
+      ]
+    end
+
+    def initialize(artists = SKIP, available_markets = SKIP, disc_number = SKIP,
+                   duration_ms = SKIP, explicit = SKIP, external_urls = SKIP,
+                   href = SKIP, id = SKIP, is_playable = SKIP,
+                   linked_from = SKIP, restrictions = SKIP, name = SKIP,
+                   preview_url = SKIP, track_number = SKIP, type = SKIP,
+                   uri = SKIP, is_local = SKIP)
+      @artists = artists unless artists == SKIP
+      @available_markets = available_markets unless available_markets == SKIP
+      @disc_number = disc_number unless disc_number == SKIP
+      @duration_ms = duration_ms unless duration_ms == SKIP
+      @explicit = explicit unless explicit == SKIP
+      @external_urls = external_urls unless external_urls == SKIP
+      @href = href unless href == SKIP
+      @id = id unless id == SKIP
+      @is_playable = is_playable unless is_playable == SKIP
+      @linked_from = linked_from unless linked_from == SKIP
+      @restrictions = restrictions unless restrictions == SKIP
+      @name = name unless name == SKIP
+      @preview_url = preview_url unless preview_url == SKIP
+      @track_number = track_number unless track_number == SKIP
+      @type = type unless type == SKIP
+      @uri = uri unless uri == SKIP
+      @is_local = is_local unless is_local == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      artists = nil
+      unless hash['artists'].nil?
+        artists = []
+        hash['artists'].each do |structure|
+          artists << (SimplifiedArtistObject.from_hash(structure) if structure)
+        end
+      end
+
+      artists = SKIP unless hash.key?('artists')
+      available_markets =
+        hash.key?('available_markets') ? hash['available_markets'] : SKIP
+      disc_number = hash.key?('disc_number') ? hash['disc_number'] : SKIP
+      duration_ms = hash.key?('duration_ms') ? hash['duration_ms'] : SKIP
+      explicit = hash.key?('explicit') ? hash['explicit'] : SKIP
+      external_urls = ExternalUrlObject.from_hash(hash['external_urls']) if hash['external_urls']
+      href = hash.key?('href') ? hash['href'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      is_playable = hash.key?('is_playable') ? hash['is_playable'] : SKIP
+      linked_from = LinkedTrackObject.from_hash(hash['linked_from']) if hash['linked_from']
+      restrictions = TrackRestrictionObject.from_hash(hash['restrictions']) if
+        hash['restrictions']
+      name = hash.key?('name') ? hash['name'] : SKIP
+      preview_url = hash.key?('preview_url') ? hash['preview_url'] : SKIP
+      track_number = hash.key?('track_number') ? hash['track_number'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      uri = hash.key?('uri') ? hash['uri'] : SKIP
+      is_local = hash.key?('is_local') ? hash['is_local'] : SKIP
+
+      # Create object from extracted values.
+      SimplifiedTrackObject.new(artists,
+                                available_markets,
+                                disc_number,
+                                duration_ms,
+                                explicit,
+                                external_urls,
+                                href,
+                                id,
+                                is_playable,
+                                linked_from,
+                                restrictions,
+                                name,
+                                preview_url,
+                                track_number,
+                                type,
+                                uri,
+                                is_local)
+    end
+  end
+end

data/lib/spotify_web_api/models/time_interval_object.rb

@@ -0,0 +1,68 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # TimeIntervalObject Model.
+  class TimeIntervalObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The starting point (in seconds) of the time interval.
+    # @return [Float]
+    attr_accessor :start
+
+    # The duration (in seconds) of the time interval.
+    # @return [Float]
+    attr_accessor :duration
+
+    # The confidence, from 0.0 to 1.0, of the reliability of the interval.
+    # @return [Float]
+    attr_accessor :confidence
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start'] = 'start'
+      @_hash['duration'] = 'duration'
+      @_hash['confidence'] = 'confidence'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        start
+        duration
+        confidence
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start = SKIP, duration = SKIP, confidence = SKIP)
+      @start = start unless start == SKIP
+      @duration = duration unless duration == SKIP
+      @confidence = confidence unless confidence == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      start = hash.key?('start') ? hash['start'] : SKIP
+      duration = hash.key?('duration') ? hash['duration'] : SKIP
+      confidence = hash.key?('confidence') ? hash['confidence'] : SKIP
+
+      # Create object from extracted values.
+      TimeIntervalObject.new(start,
+                             duration,
+                             confidence)
+    end
+  end
+end

data/lib/spotify_web_api/models/track.rb

@@ -0,0 +1,331 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # Track Model.
+  class Track < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The exact number of audio samples analyzed from this track. See also
+    # `analysis_sample_rate`.
+    # @return [Integer]
+    attr_accessor :num_samples
+
+    # Length of the track in seconds.
+    # @return [Float]
+    attr_accessor :duration
+
+    # This field will always contain the empty string.
+    # @return [String]
+    attr_accessor :sample_md5
+
+    # An offset to the start of the region of the track that was analyzed. (As
+    # the entire track is analyzed, this should always be 0.)
+    # @return [Integer]
+    attr_accessor :offset_seconds
+
+    # The length of the region of the track was analyzed, if a subset of the
+    # track was analyzed. (As the entire track is analyzed, this should always
+    # be 0.)
+    # @return [Integer]
+    attr_accessor :window_seconds
+
+    # The sample rate used to decode and analyze this track. May differ from the
+    # actual sample rate of this track available on Spotify.
+    # @return [Integer]
+    attr_accessor :analysis_sample_rate
+
+    # The number of channels used for analysis. If 1, all channels are summed
+    # together to mono before analysis.
+    # @return [Integer]
+    attr_accessor :analysis_channels
+
+    # The time, in seconds, at which the track's fade-in period ends. If the
+    # track has no fade-in, this will be 0.0.
+    # @return [Float]
+    attr_accessor :end_of_fade_in
+
+    # The time, in seconds, at which the track's fade-out period starts. If the
+    # track has no fade-out, this should match the track's length.
+    # @return [Float]
+    attr_accessor :start_of_fade_out
+
+    # The overall loudness of a track in decibels (dB). Loudness values are
+    # averaged across the entire track and are useful for comparing relative
+    # loudness of tracks. Loudness is the quality of a sound that is the primary
+    # psychological correlate of physical strength (amplitude). Values typically
+    # range between -60 and 0 db.
+    # @return [Float]
+    attr_accessor :loudness
+
+    # The overall estimated tempo of a track in beats per minute (BPM). In
+    # musical terminology, tempo is the speed or pace of a given piece and
+    # derives directly from the average beat duration.
+    # @return [Float]
+    attr_accessor :tempo
+
+    # The confidence, from 0.0 to 1.0, of the reliability of the `tempo`.
+    # @return [Float]
+    attr_accessor :tempo_confidence
+
+    # An estimated time signature. The time signature (meter) is a notational
+    # convention to specify how many beats are in each bar (or measure). The
+    # time signature ranges from 3 to 7 indicating time signatures of "3/4", to
+    # "7/4".
+    # @return [Integer]
+    attr_accessor :time_signature
+
+    # The confidence, from 0.0 to 1.0, of the reliability of the
+    # `time_signature`.
+    # @return [Float]
+    attr_accessor :time_signature_confidence
+
+    # The key the track is in. Integers map to pitches using standard [Pitch
+    # Class notation](https://en.wikipedia.org/wiki/Pitch_class). E.g. 0 = C, 1
+    # = C♯/D♭, 2 = D, and so on. If no key was detected, the value is -1.
+    # @return [Integer]
+    attr_accessor :key
+
+    # The confidence, from 0.0 to 1.0, of the reliability of the `key`.
+    # @return [Float]
+    attr_accessor :key_confidence
+
+    # Mode indicates the modality (major or minor) of a track, the type of scale
+    # from which its melodic content is derived. Major is represented by 1 and
+    # minor is 0.
+    # @return [Integer]
+    attr_accessor :mode
+
+    # The confidence, from 0.0 to 1.0, of the reliability of the `mode`.
+    # @return [Float]
+    attr_accessor :mode_confidence
+
+    # An [Echo Nest Musical Fingerprint
+    # (ENMFP)](https://academiccommons.columbia.edu/doi/10.7916/D8Q248M4)
+    # codestring for this track.
+    # @return [String]
+    attr_accessor :codestring
+
+    # A version number for the Echo Nest Musical Fingerprint format used in the
+    # codestring field.
+    # @return [Float]
+    attr_accessor :code_version
+
+    # An [EchoPrint](https://github.com/spotify/echoprint-codegen) codestring
+    # for this track.
+    # @return [String]
+    attr_accessor :echoprintstring
+
+    # A version number for the EchoPrint format used in the echoprintstring
+    # field.
+    # @return [Float]
+    attr_accessor :echoprint_version
+
+    # A [Synchstring](https://github.com/echonest/synchdata) for this track.
+    # @return [String]
+    attr_accessor :synchstring
+
+    # A version number for the Synchstring used in the synchstring field.
+    # @return [Float]
+    attr_accessor :synch_version
+
+    # A Rhythmstring for this track. The format of this string is similar to the
+    # Synchstring.
+    # @return [String]
+    attr_accessor :rhythmstring
+
+    # A version number for the Rhythmstring used in the rhythmstring field.
+    # @return [Float]
+    attr_accessor :rhythm_version
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['num_samples'] = 'num_samples'
+      @_hash['duration'] = 'duration'
+      @_hash['sample_md5'] = 'sample_md5'
+      @_hash['offset_seconds'] = 'offset_seconds'
+      @_hash['window_seconds'] = 'window_seconds'
+      @_hash['analysis_sample_rate'] = 'analysis_sample_rate'
+      @_hash['analysis_channels'] = 'analysis_channels'
+      @_hash['end_of_fade_in'] = 'end_of_fade_in'
+      @_hash['start_of_fade_out'] = 'start_of_fade_out'
+      @_hash['loudness'] = 'loudness'
+      @_hash['tempo'] = 'tempo'
+      @_hash['tempo_confidence'] = 'tempo_confidence'
+      @_hash['time_signature'] = 'time_signature'
+      @_hash['time_signature_confidence'] = 'time_signature_confidence'
+      @_hash['key'] = 'key'
+      @_hash['key_confidence'] = 'key_confidence'
+      @_hash['mode'] = 'mode'
+      @_hash['mode_confidence'] = 'mode_confidence'
+      @_hash['codestring'] = 'codestring'
+      @_hash['code_version'] = 'code_version'
+      @_hash['echoprintstring'] = 'echoprintstring'
+      @_hash['echoprint_version'] = 'echoprint_version'
+      @_hash['synchstring'] = 'synchstring'
+      @_hash['synch_version'] = 'synch_version'
+      @_hash['rhythmstring'] = 'rhythmstring'
+      @_hash['rhythm_version'] = 'rhythm_version'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        num_samples
+        duration
+        sample_md5
+        offset_seconds
+        window_seconds
+        analysis_sample_rate
+        analysis_channels
+        end_of_fade_in
+        start_of_fade_out
+        loudness
+        tempo
+        tempo_confidence
+        time_signature
+        time_signature_confidence
+        key
+        key_confidence
+        mode
+        mode_confidence
+        codestring
+        code_version
+        echoprintstring
+        echoprint_version
+        synchstring
+        synch_version
+        rhythmstring
+        rhythm_version
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(num_samples = SKIP, duration = SKIP, sample_md5 = SKIP,
+                   offset_seconds = SKIP, window_seconds = SKIP,
+                   analysis_sample_rate = SKIP, analysis_channels = SKIP,
+                   end_of_fade_in = SKIP, start_of_fade_out = SKIP,
+                   loudness = SKIP, tempo = SKIP, tempo_confidence = SKIP,
+                   time_signature = SKIP, time_signature_confidence = SKIP,
+                   key = SKIP, key_confidence = SKIP, mode = SKIP,
+                   mode_confidence = SKIP, codestring = SKIP,
+                   code_version = SKIP, echoprintstring = SKIP,
+                   echoprint_version = SKIP, synchstring = SKIP,
+                   synch_version = SKIP, rhythmstring = SKIP,
+                   rhythm_version = SKIP)
+      @num_samples = num_samples unless num_samples == SKIP
+      @duration = duration unless duration == SKIP
+      @sample_md5 = sample_md5 unless sample_md5 == SKIP
+      @offset_seconds = offset_seconds unless offset_seconds == SKIP
+      @window_seconds = window_seconds unless window_seconds == SKIP
+      @analysis_sample_rate = analysis_sample_rate unless analysis_sample_rate == SKIP
+      @analysis_channels = analysis_channels unless analysis_channels == SKIP
+      @end_of_fade_in = end_of_fade_in unless end_of_fade_in == SKIP
+      @start_of_fade_out = start_of_fade_out unless start_of_fade_out == SKIP
+      @loudness = loudness unless loudness == SKIP
+      @tempo = tempo unless tempo == SKIP
+      @tempo_confidence = tempo_confidence unless tempo_confidence == SKIP
+      @time_signature = time_signature unless time_signature == SKIP
+      unless time_signature_confidence == SKIP
+        @time_signature_confidence =
+          time_signature_confidence
+      end
+      @key = key unless key == SKIP
+      @key_confidence = key_confidence unless key_confidence == SKIP
+      @mode = mode unless mode == SKIP
+      @mode_confidence = mode_confidence unless mode_confidence == SKIP
+      @codestring = codestring unless codestring == SKIP
+      @code_version = code_version unless code_version == SKIP
+      @echoprintstring = echoprintstring unless echoprintstring == SKIP
+      @echoprint_version = echoprint_version unless echoprint_version == SKIP
+      @synchstring = synchstring unless synchstring == SKIP
+      @synch_version = synch_version unless synch_version == SKIP
+      @rhythmstring = rhythmstring unless rhythmstring == SKIP
+      @rhythm_version = rhythm_version unless rhythm_version == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      num_samples = hash.key?('num_samples') ? hash['num_samples'] : SKIP
+      duration = hash.key?('duration') ? hash['duration'] : SKIP
+      sample_md5 = hash.key?('sample_md5') ? hash['sample_md5'] : SKIP
+      offset_seconds =
+        hash.key?('offset_seconds') ? hash['offset_seconds'] : SKIP
+      window_seconds =
+        hash.key?('window_seconds') ? hash['window_seconds'] : SKIP
+      analysis_sample_rate =
+        hash.key?('analysis_sample_rate') ? hash['analysis_sample_rate'] : SKIP
+      analysis_channels =
+        hash.key?('analysis_channels') ? hash['analysis_channels'] : SKIP
+      end_of_fade_in =
+        hash.key?('end_of_fade_in') ? hash['end_of_fade_in'] : SKIP
+      start_of_fade_out =
+        hash.key?('start_of_fade_out') ? hash['start_of_fade_out'] : SKIP
+      loudness = hash.key?('loudness') ? hash['loudness'] : SKIP
+      tempo = hash.key?('tempo') ? hash['tempo'] : SKIP
+      tempo_confidence =
+        hash.key?('tempo_confidence') ? hash['tempo_confidence'] : SKIP
+      time_signature =
+        hash.key?('time_signature') ? hash['time_signature'] : SKIP
+      time_signature_confidence =
+        hash.key?('time_signature_confidence') ? hash['time_signature_confidence'] : SKIP
+      key = hash.key?('key') ? hash['key'] : SKIP
+      key_confidence =
+        hash.key?('key_confidence') ? hash['key_confidence'] : SKIP
+      mode = hash.key?('mode') ? hash['mode'] : SKIP
+      mode_confidence =
+        hash.key?('mode_confidence') ? hash['mode_confidence'] : SKIP
+      codestring = hash.key?('codestring') ? hash['codestring'] : SKIP
+      code_version = hash.key?('code_version') ? hash['code_version'] : SKIP
+      echoprintstring =
+        hash.key?('echoprintstring') ? hash['echoprintstring'] : SKIP
+      echoprint_version =
+        hash.key?('echoprint_version') ? hash['echoprint_version'] : SKIP
+      synchstring = hash.key?('synchstring') ? hash['synchstring'] : SKIP
+      synch_version = hash.key?('synch_version') ? hash['synch_version'] : SKIP
+      rhythmstring = hash.key?('rhythmstring') ? hash['rhythmstring'] : SKIP
+      rhythm_version =
+        hash.key?('rhythm_version') ? hash['rhythm_version'] : SKIP
+
+      # Create object from extracted values.
+      Track.new(num_samples,
+                duration,
+                sample_md5,
+                offset_seconds,
+                window_seconds,
+                analysis_sample_rate,
+                analysis_channels,
+                end_of_fade_in,
+                start_of_fade_out,
+                loudness,
+                tempo,
+                tempo_confidence,
+                time_signature,
+                time_signature_confidence,
+                key,
+                key_confidence,
+                mode,
+                mode_confidence,
+                codestring,
+                code_version,
+                echoprintstring,
+                echoprint_version,
+                synchstring,
+                synch_version,
+                rhythmstring,
+                rhythm_version)
+    end
+  end
+end

data/lib/spotify_web_api/models/track1.rb

@@ -0,0 +1,50 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # Track1 Model.
+  class Track1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Spotify URI
+    # @return [String]
+    attr_accessor :uri
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uri'] = 'uri'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uri
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uri = SKIP)
+      @uri = uri unless uri == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      uri = hash.key?('uri') ? hash['uri'] : SKIP
+
+      # Create object from extracted values.
+      Track1.new(uri)
+    end
+  end
+end