spotify-api-sdk 1.0.0

data/lib/spotify_web_api/models/album_type_enum.rb

@@ -0,0 +1,26 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # The type of the album.
+  class AlbumTypeEnum
+    ALBUM_TYPE_ENUM = [
+      # TODO: Write general description for ALBUM
+      ALBUM = 'album'.freeze,
+
+      # TODO: Write general description for SINGLE
+      SINGLE = 'single'.freeze,
+
+      # TODO: Write general description for COMPILATION
+      COMPILATION = 'compilation'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ALBUM_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/spotify_web_api/models/artist_discography_album_object.rb

@@ -0,0 +1,194 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # ArtistDiscographyAlbumObject Model.
+  class ArtistDiscographyAlbumObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of the album.
+    # @return [AlbumTypeEnum]
+    attr_accessor :album_type
+
+    # The number of tracks in the album.
+    # @return [Integer]
+    attr_accessor :total_tracks
+
+    # The markets in which the album is available: [ISO 3166-1 alpha-2 country
+    # codes](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). _**NOTE**: an
+    # album is considered available in a market when at least 1 of its tracks is
+    # available in that market._
+    # @return [Array[String]]
+    attr_accessor :available_markets
+
+    # Known external URLs for this album.
+    # @return [ExternalUrlObject]
+    attr_accessor :external_urls
+
+    # A link to the Web API endpoint providing full details of the album.
+    # @return [String]
+    attr_accessor :href
+
+    # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+    # album.
+    # @return [String]
+    attr_accessor :id
+
+    # The cover art for the album in various sizes, widest first.
+    # @return [Array[ImageObject]]
+    attr_accessor :images
+
+    # The name of the album. In case of an album takedown, the value may be an
+    # empty string.
+    # @return [String]
+    attr_accessor :name
+
+    # The date the album was first released.
+    # @return [String]
+    attr_accessor :release_date
+
+    # The precision with which `release_date` value is known.
+    # @return [ReleaseDatePrecisionEnum]
+    attr_accessor :release_date_precision
+
+    # Included in the response when a content restriction is applied.
+    # @return [AlbumRestrictionObject]
+    attr_accessor :restrictions
+
+    # The object type.
+    # @return [Type2Enum]
+    attr_accessor :type
+
+    # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for
+    # the album.
+    # @return [String]
+    attr_accessor :uri
+
+    # The artists of the album. Each artist object includes a link in `href` to
+    # more detailed information about the artist.
+    # @return [Array[SimplifiedArtistObject]]
+    attr_accessor :artists
+
+    # This field describes the relationship between the artist and the album.
+    # @return [AlbumGroupEnum]
+    attr_accessor :album_group
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['album_type'] = 'album_type'
+      @_hash['total_tracks'] = 'total_tracks'
+      @_hash['available_markets'] = 'available_markets'
+      @_hash['external_urls'] = 'external_urls'
+      @_hash['href'] = 'href'
+      @_hash['id'] = 'id'
+      @_hash['images'] = 'images'
+      @_hash['name'] = 'name'
+      @_hash['release_date'] = 'release_date'
+      @_hash['release_date_precision'] = 'release_date_precision'
+      @_hash['restrictions'] = 'restrictions'
+      @_hash['type'] = 'type'
+      @_hash['uri'] = 'uri'
+      @_hash['artists'] = 'artists'
+      @_hash['album_group'] = 'album_group'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        restrictions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(album_type = nil, total_tracks = nil,
+                   available_markets = nil, external_urls = nil, href = nil,
+                   id = nil, images = nil, name = nil, release_date = nil,
+                   release_date_precision = nil, type = nil, uri = nil,
+                   artists = nil, album_group = nil, restrictions = SKIP)
+      @album_type = album_type
+      @total_tracks = total_tracks
+      @available_markets = available_markets
+      @external_urls = external_urls
+      @href = href
+      @id = id
+      @images = images
+      @name = name
+      @release_date = release_date
+      @release_date_precision = release_date_precision
+      @restrictions = restrictions unless restrictions == SKIP
+      @type = type
+      @uri = uri
+      @artists = artists
+      @album_group = album_group
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      album_type = hash.key?('album_type') ? hash['album_type'] : nil
+      total_tracks = hash.key?('total_tracks') ? hash['total_tracks'] : nil
+      available_markets =
+        hash.key?('available_markets') ? hash['available_markets'] : nil
+      external_urls = ExternalUrlObject.from_hash(hash['external_urls']) if hash['external_urls']
+      href = hash.key?('href') ? hash['href'] : nil
+      id = hash.key?('id') ? hash['id'] : nil
+      # Parameter is an array, so we need to iterate through it
+      images = nil
+      unless hash['images'].nil?
+        images = []
+        hash['images'].each do |structure|
+          images << (ImageObject.from_hash(structure) if structure)
+        end
+      end
+
+      images = nil unless hash.key?('images')
+      name = hash.key?('name') ? hash['name'] : nil
+      release_date = hash.key?('release_date') ? hash['release_date'] : nil
+      release_date_precision =
+        hash.key?('release_date_precision') ? hash['release_date_precision'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+      uri = hash.key?('uri') ? hash['uri'] : nil
+      # 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 = nil unless hash.key?('artists')
+      album_group = hash.key?('album_group') ? hash['album_group'] : nil
+      restrictions = AlbumRestrictionObject.from_hash(hash['restrictions']) if
+        hash['restrictions']
+
+      # Create object from extracted values.
+      ArtistDiscographyAlbumObject.new(album_type,
+                                       total_tracks,
+                                       available_markets,
+                                       external_urls,
+                                       href,
+                                       id,
+                                       images,
+                                       name,
+                                       release_date,
+                                       release_date_precision,
+                                       type,
+                                       uri,
+                                       artists,
+                                       album_group,
+                                       restrictions)
+    end
+  end
+end

data/lib/spotify_web_api/models/artist_object.rb

@@ -0,0 +1,147 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # ArtistObject Model.
+  class ArtistObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Known external URLs for this artist.
+    # @return [ExternalUrlObject]
+    attr_accessor :external_urls
+
+    # Information about the followers of the artist.
+    # @return [FollowersObject]
+    attr_accessor :followers
+
+    # A list of the genres the artist is associated with. If not yet classified,
+    # the array is empty.
+    # @return [Array[String]]
+    attr_accessor :genres
+
+    # A link to the Web API endpoint providing full details of the artist.
+    # @return [String]
+    attr_accessor :href
+
+    # The [Spotify ID](/documentation/web-api/concepts/spotify-uris-ids) for the
+    # artist.
+    # @return [String]
+    attr_accessor :id
+
+    # Images of the artist in various sizes, widest first.
+    # @return [Array[ImageObject]]
+    attr_accessor :images
+
+    # The name of the artist.
+    # @return [String]
+    attr_accessor :name
+
+    # The popularity of the artist. The value will be between 0 and 100, with
+    # 100 being the most popular. The artist's popularity is calculated from the
+    # popularity of all the artist's tracks.
+    # @return [Integer]
+    attr_accessor :popularity
+
+    # The object type.
+    # @return [TypeEnum]
+    attr_accessor :type
+
+    # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for
+    # the artist.
+    # @return [String]
+    attr_accessor :uri
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['external_urls'] = 'external_urls'
+      @_hash['followers'] = 'followers'
+      @_hash['genres'] = 'genres'
+      @_hash['href'] = 'href'
+      @_hash['id'] = 'id'
+      @_hash['images'] = 'images'
+      @_hash['name'] = 'name'
+      @_hash['popularity'] = 'popularity'
+      @_hash['type'] = 'type'
+      @_hash['uri'] = 'uri'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        external_urls
+        followers
+        genres
+        href
+        id
+        images
+        name
+        popularity
+        type
+        uri
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(external_urls = SKIP, followers = SKIP, genres = SKIP,
+                   href = SKIP, id = SKIP, images = SKIP, name = SKIP,
+                   popularity = SKIP, type = SKIP, uri = SKIP)
+      @external_urls = external_urls unless external_urls == SKIP
+      @followers = followers unless followers == SKIP
+      @genres = genres unless genres == SKIP
+      @href = href unless href == SKIP
+      @id = id unless id == SKIP
+      @images = images unless images == SKIP
+      @name = name unless name == SKIP
+      @popularity = popularity unless popularity == SKIP
+      @type = type unless type == 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.
+      external_urls = ExternalUrlObject.from_hash(hash['external_urls']) if hash['external_urls']
+      followers = FollowersObject.from_hash(hash['followers']) if hash['followers']
+      genres = hash.key?('genres') ? hash['genres'] : SKIP
+      href = hash.key?('href') ? hash['href'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      images = nil
+      unless hash['images'].nil?
+        images = []
+        hash['images'].each do |structure|
+          images << (ImageObject.from_hash(structure) if structure)
+        end
+      end
+
+      images = SKIP unless hash.key?('images')
+      name = hash.key?('name') ? hash['name'] : SKIP
+      popularity = hash.key?('popularity') ? hash['popularity'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      uri = hash.key?('uri') ? hash['uri'] : SKIP
+
+      # Create object from extracted values.
+      ArtistObject.new(external_urls,
+                       followers,
+                       genres,
+                       href,
+                       id,
+                       images,
+                       name,
+                       popularity,
+                       type,
+                       uri)
+    end
+  end
+end

data/lib/spotify_web_api/models/audio_analysis_object.rb

@@ -0,0 +1,156 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # AudioAnalysisObject Model.
+  class AudioAnalysisObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Meta]
+    attr_accessor :meta
+
+    # TODO: Write general description for this method
+    # @return [Track]
+    attr_accessor :track
+
+    # The time intervals of the bars throughout the track. A bar (or measure) is
+    # a segment of time defined as a given number of beats.
+    # @return [Array[TimeIntervalObject]]
+    attr_accessor :bars
+
+    # The time intervals of beats throughout the track. A beat is the basic time
+    # unit of a piece of music; for example, each tick of a metronome. Beats are
+    # typically multiples of tatums.
+    # @return [Array[TimeIntervalObject]]
+    attr_accessor :beats
+
+    # Sections are defined by large variations in rhythm or timbre, e.g. chorus,
+    # verse, bridge, guitar solo, etc. Each section contains its own
+    # descriptions of tempo, key, mode, time_signature, and loudness.
+    # @return [Array[SectionObject]]
+    attr_accessor :sections
+
+    # Each segment contains a roughly conisistent sound throughout its duration.
+    # @return [Array[SegmentObject]]
+    attr_accessor :segments
+
+    # A tatum represents the lowest regular pulse train that a listener
+    # intuitively infers from the timing of perceived musical events (segments).
+    # @return [Array[TimeIntervalObject]]
+    attr_accessor :tatums
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['meta'] = 'meta'
+      @_hash['track'] = 'track'
+      @_hash['bars'] = 'bars'
+      @_hash['beats'] = 'beats'
+      @_hash['sections'] = 'sections'
+      @_hash['segments'] = 'segments'
+      @_hash['tatums'] = 'tatums'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        meta
+        track
+        bars
+        beats
+        sections
+        segments
+        tatums
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(meta = SKIP, track = SKIP, bars = SKIP, beats = SKIP,
+                   sections = SKIP, segments = SKIP, tatums = SKIP)
+      @meta = meta unless meta == SKIP
+      @track = track unless track == SKIP
+      @bars = bars unless bars == SKIP
+      @beats = beats unless beats == SKIP
+      @sections = sections unless sections == SKIP
+      @segments = segments unless segments == SKIP
+      @tatums = tatums unless tatums == 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.
+      meta = Meta.from_hash(hash['meta']) if hash['meta']
+      track = Track.from_hash(hash['track']) if hash['track']
+      # Parameter is an array, so we need to iterate through it
+      bars = nil
+      unless hash['bars'].nil?
+        bars = []
+        hash['bars'].each do |structure|
+          bars << (TimeIntervalObject.from_hash(structure) if structure)
+        end
+      end
+
+      bars = SKIP unless hash.key?('bars')
+      # Parameter is an array, so we need to iterate through it
+      beats = nil
+      unless hash['beats'].nil?
+        beats = []
+        hash['beats'].each do |structure|
+          beats << (TimeIntervalObject.from_hash(structure) if structure)
+        end
+      end
+
+      beats = SKIP unless hash.key?('beats')
+      # Parameter is an array, so we need to iterate through it
+      sections = nil
+      unless hash['sections'].nil?
+        sections = []
+        hash['sections'].each do |structure|
+          sections << (SectionObject.from_hash(structure) if structure)
+        end
+      end
+
+      sections = SKIP unless hash.key?('sections')
+      # Parameter is an array, so we need to iterate through it
+      segments = nil
+      unless hash['segments'].nil?
+        segments = []
+        hash['segments'].each do |structure|
+          segments << (SegmentObject.from_hash(structure) if structure)
+        end
+      end
+
+      segments = SKIP unless hash.key?('segments')
+      # Parameter is an array, so we need to iterate through it
+      tatums = nil
+      unless hash['tatums'].nil?
+        tatums = []
+        hash['tatums'].each do |structure|
+          tatums << (TimeIntervalObject.from_hash(structure) if structure)
+        end
+      end
+
+      tatums = SKIP unless hash.key?('tatums')
+
+      # Create object from extracted values.
+      AudioAnalysisObject.new(meta,
+                              track,
+                              bars,
+                              beats,
+                              sections,
+                              segments,
+                              tatums)
+    end
+  end
+end