spotify-api-sdk 1.0.0

data/lib/spotify_web_api/models/track_object.rb

@@ -0,0 +1,265 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # TrackObject Model.
+  class TrackObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The album on which the track appears. The album object includes a link in
+    # `href` to full information about the album.
+    # @return [SimplifiedAlbumObject]
+    attr_accessor :album
+
+    # The artists who performed the track. Each artist object includes a link in
+    # `href` to more detailed information about the artist.
+    # @return [Array[ArtistObject]]
+    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
+
+    # Known external IDs for the track.
+    # @return [ExternalIdObject]
+    attr_accessor :external_ids
+
+    # Known 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 the requested track has been replaced with 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
+
+    # The popularity of the track. The value will be between 0 and 100, with 100
+    # being the most popular.<br/>The popularity of a track is a value between 0
+    # and 100, with 100 being the most popular. The popularity is calculated by
+    # algorithm and is based, in the most part, on the total number of plays the
+    # track has had and how recent those plays are.<br/>Generally speaking,
+    # songs that are being played a lot now will have a higher popularity than
+    # songs that were played a lot in the past. Duplicate tracks (e.g. the same
+    # track from a single and an album) are rated independently. Artist and
+    # album popularity is derived mathematically from track popularity.
+    # _**Note**: the popularity value may lag actual popularity by a few days:
+    # the value is not updated in real time._
+    # @return [Integer]
+    attr_accessor :popularity
+
+    # A link to a 30 second preview (MP3 format) of the track. Can be `null`
+    # @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 [Type3Enum]
+    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['album'] = 'album'
+      @_hash['artists'] = 'artists'
+      @_hash['available_markets'] = 'available_markets'
+      @_hash['disc_number'] = 'disc_number'
+      @_hash['duration_ms'] = 'duration_ms'
+      @_hash['explicit'] = 'explicit'
+      @_hash['external_ids'] = 'external_ids'
+      @_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['popularity'] = 'popularity'
+      @_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[
+        album
+        artists
+        available_markets
+        disc_number
+        duration_ms
+        explicit
+        external_ids
+        external_urls
+        href
+        id
+        is_playable
+        linked_from
+        restrictions
+        name
+        popularity
+        preview_url
+        track_number
+        type
+        uri
+        is_local
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        preview_url
+      ]
+    end
+
+    def initialize(album = SKIP, artists = SKIP, available_markets = SKIP,
+                   disc_number = SKIP, duration_ms = SKIP, explicit = SKIP,
+                   external_ids = SKIP, external_urls = SKIP, href = SKIP,
+                   id = SKIP, is_playable = SKIP, linked_from = SKIP,
+                   restrictions = SKIP, name = SKIP, popularity = SKIP,
+                   preview_url = SKIP, track_number = SKIP, type = SKIP,
+                   uri = SKIP, is_local = SKIP)
+      @album = album unless album == 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_ids = external_ids unless external_ids == 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
+      @popularity = popularity unless popularity == 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.
+      album = SimplifiedAlbumObject.from_hash(hash['album']) if hash['album']
+      # Parameter is an array, so we need to iterate through it
+      artists = nil
+      unless hash['artists'].nil?
+        artists = []
+        hash['artists'].each do |structure|
+          artists << (ArtistObject.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_ids = ExternalIdObject.from_hash(hash['external_ids']) if hash['external_ids']
+      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
+      popularity = hash.key?('popularity') ? hash['popularity'] : 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.
+      TrackObject.new(album,
+                      artists,
+                      available_markets,
+                      disc_number,
+                      duration_ms,
+                      explicit,
+                      external_ids,
+                      external_urls,
+                      href,
+                      id,
+                      is_playable,
+                      linked_from,
+                      restrictions,
+                      name,
+                      popularity,
+                      preview_url,
+                      track_number,
+                      type,
+                      uri,
+                      is_local)
+    end
+  end
+end

data/lib/spotify_web_api/models/track_restriction_object.rb

@@ -0,0 +1,58 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # TrackRestrictionObject Model.
+  class TrackRestrictionObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The reason for the restriction. Supported values:
+    # - `market` - The content item is not available in the given market.
+    # - `product` - The content item is not available for the user's
+    # subscription type.
+    # - `explicit` - The content item is explicit and the user's account is set
+    # to not play explicit content.
+    # Additional reasons may be added in the future.
+    # **Note**: If you use this field, make sure that your application safely
+    # handles unknown values.
+    # @return [String]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reason = SKIP)
+      @reason = reason unless reason == 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.
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+
+      # Create object from extracted values.
+      TrackRestrictionObject.new(reason)
+    end
+  end
+end

data/lib/spotify_web_api/models/type2_enum.rb

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

data/lib/spotify_web_api/models/type3_enum.rb

@@ -0,0 +1,20 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # The object type: "track".
+  class Type3Enum
+    TYPE3_ENUM = [
+      # TODO: Write general description for TRACK
+      TRACK = 'track'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE3_ENUM.include?(value)
+    end
+  end
+end

data/lib/spotify_web_api/models/type4_enum.rb

@@ -0,0 +1,20 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # The object type.
+  class Type4Enum
+    TYPE4_ENUM = [
+      # TODO: Write general description for USER
+      USER = 'user'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE4_ENUM.include?(value)
+    end
+  end
+end

data/lib/spotify_web_api/models/type6_enum.rb

@@ -0,0 +1,20 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # The object type.
+  class Type6Enum
+    TYPE6_ENUM = [
+      # TODO: Write general description for AUDIO_FEATURES
+      AUDIO_FEATURES = 'audio_features'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE6_ENUM.include?(value)
+    end
+  end
+end

data/lib/spotify_web_api/models/type7_enum.rb

@@ -0,0 +1,20 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # The object type.
+  class Type7Enum
+    TYPE7_ENUM = [
+      # TODO: Write general description for SHOW
+      SHOW = 'show'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE7_ENUM.include?(value)
+    end
+  end
+end

data/lib/spotify_web_api/models/type8_enum.rb

@@ -0,0 +1,20 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # The object type.
+  class Type8Enum
+    TYPE8_ENUM = [
+      # TODO: Write general description for EPISODE
+      EPISODE = 'episode'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE8_ENUM.include?(value)
+    end
+  end
+end

data/lib/spotify_web_api/models/type9_enum.rb

@@ -0,0 +1,20 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # The object type.
+  class Type9Enum
+    TYPE9_ENUM = [
+      # TODO: Write general description for AUDIOBOOK
+      AUDIOBOOK = 'audiobook'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE9_ENUM.include?(value)
+    end
+  end
+end

data/lib/spotify_web_api/models/type_enum.rb

@@ -0,0 +1,20 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # The object type.
+  class TypeEnum
+    TYPE_ENUM = [
+      # TODO: Write general description for ARTIST
+      ARTIST = 'artist'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/spotify_web_api/models/users_playlists_request.rb

@@ -0,0 +1,87 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # UsersPlaylistsRequest Model.
+  class UsersPlaylistsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name for the new playlist, for example `"Your Coolest Playlist"`. This
+    # name does not need to be unique; a user may have several playlists with
+    # the same name.
+    # @return [String]
+    attr_accessor :name
+
+    # Defaults to `true`. If `true` the playlist will be public, if `false` it
+    # will be private. To be able to create private playlists, the user must
+    # have granted the `playlist-modify-private`
+    # [scope](/documentation/web-api/concepts/scopes/#list-of-scopes)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :public
+
+    # Defaults to `false`. If `true` the playlist will be collaborative.
+    # _**Note**: to create a collaborative playlist you must also set `public`
+    # to `false`. To create collaborative playlists you must have granted
+    # `playlist-modify-private` and `playlist-modify-public`
+    # [scopes](/documentation/web-api/concepts/scopes/#list-of-scopes)._
+    # @return [TrueClass | FalseClass]
+    attr_accessor :collaborative
+
+    # value for playlist description as displayed in Spotify Clients and in the
+    # Web API.
+    # @return [String]
+    attr_accessor :description
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['public'] = 'public'
+      @_hash['collaborative'] = 'collaborative'
+      @_hash['description'] = 'description'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        public
+        collaborative
+        description
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil, public = SKIP, collaborative = SKIP,
+                   description = SKIP)
+      @name = name
+      @public = public unless public == SKIP
+      @collaborative = collaborative unless collaborative == SKIP
+      @description = description unless description == 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.
+      name = hash.key?('name') ? hash['name'] : nil
+      public = hash.key?('public') ? hash['public'] : SKIP
+      collaborative = hash.key?('collaborative') ? hash['collaborative'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+
+      # Create object from extracted values.
+      UsersPlaylistsRequest.new(name,
+                                public,
+                                collaborative,
+                                description)
+    end
+  end
+end

data/lib/spotify_web_api/utilities/date_time_helper.rb

@@ -0,0 +1,11 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'date'
+module SpotifyWebApi
+  # A utility  that supports dateTime conversion to different formats
+  class DateTimeHelper < CoreLibrary::DateTimeHelper
+  end
+end

data/lib/spotify_web_api/utilities/file_wrapper.rb

@@ -0,0 +1,16 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # A utility to allow users to set the content-type for files
+  class FileWrapper < CoreLibrary::FileWrapper
+    # The constructor.
+    # @param [File] file The file to be sent in the request.
+    # @param [string] content_type The content type of the provided file.
+    def initialize(file, content_type: 'application/octet-stream')
+      super
+    end
+  end
+end