spotify-api-sdk 1.0.0

data/lib/spotify_web_api/models/playlists_tracks_request1.rb

@@ -0,0 +1,97 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PlaylistsTracksRequest1 Model.
+  class PlaylistsTracksRequest1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :uris
+
+    # The position of the first item to be reordered.
+    # @return [Integer]
+    attr_accessor :range_start
+
+    # The position where the items should be inserted.<br/>To reorder the items
+    # to the end of the playlist, simply set _insert_before_ to the position
+    # after the last item.<br/>Examples:<br/>To reorder the first item to the
+    # last position in a playlist with 10 items, set _range_start_ to 0, and
+    # _insert_before_ to 10.<br/>To reorder the last item in a playlist with 10
+    # items to the start of the playlist, set _range_start_ to 9, and
+    # _insert_before_ to 0.
+    # @return [Integer]
+    attr_accessor :insert_before
+
+    # The amount of items to be reordered. Defaults to 1 if not set.<br/>The
+    # range of items to be reordered begins from the _range_start_ position, and
+    # includes the _range_length_ subsequent items.<br/>Example:<br/>To move the
+    # items at index 9-10 to the start of the playlist, _range_start_ is set to
+    # 9, and _range_length_ is set to 2.
+    # @return [Integer]
+    attr_accessor :range_length
+
+    # The playlist's snapshot ID against which you want to make the changes.
+    # @return [String]
+    attr_accessor :snapshot_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['uris'] = 'uris'
+      @_hash['range_start'] = 'range_start'
+      @_hash['insert_before'] = 'insert_before'
+      @_hash['range_length'] = 'range_length'
+      @_hash['snapshot_id'] = 'snapshot_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        uris
+        range_start
+        insert_before
+        range_length
+        snapshot_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(uris = SKIP, range_start = SKIP, insert_before = SKIP,
+                   range_length = SKIP, snapshot_id = SKIP)
+      @uris = uris unless uris == SKIP
+      @range_start = range_start unless range_start == SKIP
+      @insert_before = insert_before unless insert_before == SKIP
+      @range_length = range_length unless range_length == SKIP
+      @snapshot_id = snapshot_id unless snapshot_id == 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.
+      uris = hash.key?('uris') ? hash['uris'] : SKIP
+      range_start = hash.key?('range_start') ? hash['range_start'] : SKIP
+      insert_before = hash.key?('insert_before') ? hash['insert_before'] : SKIP
+      range_length = hash.key?('range_length') ? hash['range_length'] : SKIP
+      snapshot_id = hash.key?('snapshot_id') ? hash['snapshot_id'] : SKIP
+
+      # Create object from extracted values.
+      PlaylistsTracksRequest1.new(uris,
+                                  range_start,
+                                  insert_before,
+                                  range_length,
+                                  snapshot_id)
+    end
+  end
+end

data/lib/spotify_web_api/models/playlists_tracks_request2.rb

@@ -0,0 +1,75 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PlaylistsTracksRequest2 Model.
+  class PlaylistsTracksRequest2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An array of objects containing [Spotify
+    # URIs](/documentation/web-api/concepts/spotify-uris-ids) of the tracks or
+    # episodes to remove.
+    # For example: `{ "tracks": [{ "uri": "spotify:track:4iV5W9uYEdYUVa79Axb7Rh"
+    # },{ "uri": "spotify:track:1301WleyT98MSxVHPZCA6M" }] }`. A maximum of 100
+    # objects can be sent at once.
+    # @return [Array[Track1]]
+    attr_accessor :tracks
+
+    # The playlist's snapshot ID against which you want to make the changes.
+    # The API will validate that the specified items exist and in the specified
+    # positions and make the changes,
+    # even if more recent changes have been made to the playlist.
+    # @return [String]
+    attr_accessor :snapshot_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tracks'] = 'tracks'
+      @_hash['snapshot_id'] = 'snapshot_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        snapshot_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tracks = nil, snapshot_id = SKIP)
+      @tracks = tracks
+      @snapshot_id = snapshot_id unless snapshot_id == 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
+      tracks = nil
+      unless hash['tracks'].nil?
+        tracks = []
+        hash['tracks'].each do |structure|
+          tracks << (Track1.from_hash(structure) if structure)
+        end
+      end
+
+      tracks = nil unless hash.key?('tracks')
+      snapshot_id = hash.key?('snapshot_id') ? hash['snapshot_id'] : SKIP
+
+      # Create object from extracted values.
+      PlaylistsTracksRequest2.new(tracks,
+                                  snapshot_id)
+    end
+  end
+end

data/lib/spotify_web_api/models/private_user_object.rb

@@ -0,0 +1,181 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PrivateUserObject Model.
+  class PrivateUserObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The country of the user, as set in the user's account profile. An [ISO
+    # 3166-1 alpha-2 country
+    # code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). _This field is
+    # only available when the current user has granted access to the
+    # [user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes
+    # ) scope._
+    # @return [String]
+    attr_accessor :country
+
+    # The name displayed on the user's profile. `null` if not available.
+    # @return [String]
+    attr_accessor :display_name
+
+    # The user's email address, as entered by the user when creating their
+    # account. _**Important!** This email address is unverified; there is no
+    # proof that it actually belongs to the user._ _This field is only available
+    # when the current user has granted access to the
+    # [user-read-email](/documentation/web-api/concepts/scopes/#list-of-scopes)
+    # scope._
+    # @return [String]
+    attr_accessor :email
+
+    # The user's explicit content settings. _This field is only available when
+    # the current user has granted access to the
+    # [user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes
+    # ) scope._
+    # @return [ExplicitContentSettingsObject]
+    attr_accessor :explicit_content
+
+    # Known external URLs for this user.
+    # @return [ExternalUrlObject]
+    attr_accessor :external_urls
+
+    # Information about the followers of the user.
+    # @return [FollowersObject]
+    attr_accessor :followers
+
+    # A link to the Web API endpoint for this user.
+    # @return [String]
+    attr_accessor :href
+
+    # The [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids)
+    # for the user.
+    # @return [String]
+    attr_accessor :id
+
+    # The user's profile image.
+    # @return [Array[ImageObject]]
+    attr_accessor :images
+
+    # The user's Spotify subscription level: "premium", "free", etc. (The
+    # subscription level "open" can be considered the same as "free".) _This
+    # field is only available when the current user has granted access to the
+    # [user-read-private](/documentation/web-api/concepts/scopes/#list-of-scopes
+    # ) scope._
+    # @return [String]
+    attr_accessor :product
+
+    # The object type: "user"
+    # @return [String]
+    attr_accessor :type
+
+    # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for
+    # the user.
+    # @return [String]
+    attr_accessor :uri
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country'] = 'country'
+      @_hash['display_name'] = 'display_name'
+      @_hash['email'] = 'email'
+      @_hash['explicit_content'] = 'explicit_content'
+      @_hash['external_urls'] = 'external_urls'
+      @_hash['followers'] = 'followers'
+      @_hash['href'] = 'href'
+      @_hash['id'] = 'id'
+      @_hash['images'] = 'images'
+      @_hash['product'] = 'product'
+      @_hash['type'] = 'type'
+      @_hash['uri'] = 'uri'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        country
+        display_name
+        email
+        explicit_content
+        external_urls
+        followers
+        href
+        id
+        images
+        product
+        type
+        uri
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country = SKIP, display_name = SKIP, email = SKIP,
+                   explicit_content = SKIP, external_urls = SKIP,
+                   followers = SKIP, href = SKIP, id = SKIP, images = SKIP,
+                   product = SKIP, type = SKIP, uri = SKIP)
+      @country = country unless country == SKIP
+      @display_name = display_name unless display_name == SKIP
+      @email = email unless email == SKIP
+      @explicit_content = explicit_content unless explicit_content == SKIP
+      @external_urls = external_urls unless external_urls == SKIP
+      @followers = followers unless followers == SKIP
+      @href = href unless href == SKIP
+      @id = id unless id == SKIP
+      @images = images unless images == SKIP
+      @product = product unless product == 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.
+      country = hash.key?('country') ? hash['country'] : SKIP
+      display_name = hash.key?('display_name') ? hash['display_name'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      explicit_content = ExplicitContentSettingsObject.from_hash(hash['explicit_content']) if
+        hash['explicit_content']
+      external_urls = ExternalUrlObject.from_hash(hash['external_urls']) if hash['external_urls']
+      followers = FollowersObject.from_hash(hash['followers']) if hash['followers']
+      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')
+      product = hash.key?('product') ? hash['product'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      uri = hash.key?('uri') ? hash['uri'] : SKIP
+
+      # Create object from extracted values.
+      PrivateUserObject.new(country,
+                            display_name,
+                            email,
+                            explicit_content,
+                            external_urls,
+                            followers,
+                            href,
+                            id,
+                            images,
+                            product,
+                            type,
+                            uri)
+    end
+  end
+end

data/lib/spotify_web_api/models/public_user_object.rb

@@ -0,0 +1,128 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # PublicUserObject Model.
+  class PublicUserObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name displayed on the user's profile. `null` if not available.
+    # @return [String]
+    attr_accessor :display_name
+
+    # Known public external URLs for this user.
+    # @return [ExternalUrlObject]
+    attr_accessor :external_urls
+
+    # Information about the followers of this user.
+    # @return [FollowersObject]
+    attr_accessor :followers
+
+    # A link to the Web API endpoint for this user.
+    # @return [String]
+    attr_accessor :href
+
+    # The [Spotify user ID](/documentation/web-api/concepts/spotify-uris-ids)
+    # for this user.
+    # @return [String]
+    attr_accessor :id
+
+    # The user's profile image.
+    # @return [Array[ImageObject]]
+    attr_accessor :images
+
+    # The object type.
+    # @return [Type4Enum]
+    attr_accessor :type
+
+    # The [Spotify URI](/documentation/web-api/concepts/spotify-uris-ids) for
+    # this user.
+    # @return [String]
+    attr_accessor :uri
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['display_name'] = 'display_name'
+      @_hash['external_urls'] = 'external_urls'
+      @_hash['followers'] = 'followers'
+      @_hash['href'] = 'href'
+      @_hash['id'] = 'id'
+      @_hash['images'] = 'images'
+      @_hash['type'] = 'type'
+      @_hash['uri'] = 'uri'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        display_name
+        external_urls
+        followers
+        href
+        id
+        images
+        type
+        uri
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        display_name
+      ]
+    end
+
+    def initialize(display_name = SKIP, external_urls = SKIP, followers = SKIP,
+                   href = SKIP, id = SKIP, images = SKIP, type = SKIP,
+                   uri = SKIP)
+      @display_name = display_name unless display_name == SKIP
+      @external_urls = external_urls unless external_urls == SKIP
+      @followers = followers unless followers == SKIP
+      @href = href unless href == SKIP
+      @id = id unless id == SKIP
+      @images = images unless images == 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.
+      display_name = hash.key?('display_name') ? hash['display_name'] : SKIP
+      external_urls = ExternalUrlObject.from_hash(hash['external_urls']) if hash['external_urls']
+      followers = FollowersObject.from_hash(hash['followers']) if hash['followers']
+      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')
+      type = hash.key?('type') ? hash['type'] : SKIP
+      uri = hash.key?('uri') ? hash['uri'] : SKIP
+
+      # Create object from extracted values.
+      PublicUserObject.new(display_name,
+                           external_urls,
+                           followers,
+                           href,
+                           id,
+                           images,
+                           type,
+                           uri)
+    end
+  end
+end

data/lib/spotify_web_api/models/queue_object.rb

@@ -0,0 +1,60 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # QueueObject Model.
+  class QueueObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The currently playing track or episode. Can be `null`.
+    # @return [Object]
+    attr_accessor :currently_playing
+
+    # The tracks or episodes in the queue. Can be empty.
+    # @return [Array[Object]]
+    attr_accessor :queue
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currently_playing'] = 'currently_playing'
+      @_hash['queue'] = 'queue'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        currently_playing
+        queue
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currently_playing = SKIP, queue = SKIP)
+      @currently_playing = currently_playing unless currently_playing == SKIP
+      @queue = queue unless queue == 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.
+      currently_playing =
+        hash.key?('currently_playing') ? hash['currently_playing'] : SKIP
+      queue = hash.key?('queue') ? hash['queue'] : SKIP
+
+      # Create object from extracted values.
+      QueueObject.new(currently_playing,
+                      queue)
+    end
+  end
+end

data/lib/spotify_web_api/models/reason_enum.rb

@@ -0,0 +1,29 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # The reason for the restriction. Albums may be restricted if the content is
+  # not available in a given market, to the user's subscription type, or when
+  # the user's account is set to not play explicit content. Additional reasons
+  # may be added in the future.
+  class ReasonEnum
+    REASON_ENUM = [
+      # TODO: Write general description for MARKET
+      MARKET = 'market'.freeze,
+
+      # TODO: Write general description for PRODUCT
+      PRODUCT = 'product'.freeze,
+
+      # TODO: Write general description for EXPLICIT
+      EXPLICIT = 'explicit'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REASON_ENUM.include?(value)
+    end
+  end
+end

data/lib/spotify_web_api/models/recommendation_seed_object.rb

@@ -0,0 +1,104 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # RecommendationSeedObject Model.
+  class RecommendationSeedObject < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The number of tracks available after min\_\* and max\_\* filters have been
+    # applied.
+    # @return [Integer]
+    attr_accessor :after_filtering_size
+
+    # The number of tracks available after relinking for regional availability.
+    # @return [Integer]
+    attr_accessor :after_relinking_size
+
+    # A link to the full track or artist data for this seed. For tracks this
+    # will be a link to a Track Object. For artists a link to an Artist Object.
+    # For genre seeds, this value will be `null`.
+    # @return [String]
+    attr_accessor :href
+
+    # The id used to select this seed. This will be the same as the string used
+    # in the `seed_artists`, `seed_tracks` or `seed_genres` parameter.
+    # @return [String]
+    attr_accessor :id
+
+    # The number of recommended tracks available for this seed.
+    # @return [Integer]
+    attr_accessor :initial_pool_size
+
+    # The entity type of this seed. One of `artist`, `track` or `genre`.
+    # @return [String]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['after_filtering_size'] = 'afterFilteringSize'
+      @_hash['after_relinking_size'] = 'afterRelinkingSize'
+      @_hash['href'] = 'href'
+      @_hash['id'] = 'id'
+      @_hash['initial_pool_size'] = 'initialPoolSize'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        after_filtering_size
+        after_relinking_size
+        href
+        id
+        initial_pool_size
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(after_filtering_size = SKIP, after_relinking_size = SKIP,
+                   href = SKIP, id = SKIP, initial_pool_size = SKIP,
+                   type = SKIP)
+      @after_filtering_size = after_filtering_size unless after_filtering_size == SKIP
+      @after_relinking_size = after_relinking_size unless after_relinking_size == SKIP
+      @href = href unless href == SKIP
+      @id = id unless id == SKIP
+      @initial_pool_size = initial_pool_size unless initial_pool_size == SKIP
+      @type = type unless type == 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.
+      after_filtering_size =
+        hash.key?('afterFilteringSize') ? hash['afterFilteringSize'] : SKIP
+      after_relinking_size =
+        hash.key?('afterRelinkingSize') ? hash['afterRelinkingSize'] : SKIP
+      href = hash.key?('href') ? hash['href'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+      initial_pool_size =
+        hash.key?('initialPoolSize') ? hash['initialPoolSize'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+
+      # Create object from extracted values.
+      RecommendationSeedObject.new(after_filtering_size,
+                                   after_relinking_size,
+                                   href,
+                                   id,
+                                   initial_pool_size,
+                                   type)
+    end
+  end
+end