spotify-api-sdk 1.0.0

data/lib/spotify_web_api/models/many_tracks.rb

@@ -0,0 +1,57 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # ManyTracks Model.
+  class ManyTracks < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[TrackObject]]
+    attr_accessor :tracks
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tracks'] = 'tracks'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tracks = nil)
+      @tracks = tracks
+    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 << (TrackObject.from_hash(structure) if structure)
+        end
+      end
+
+      tracks = nil unless hash.key?('tracks')
+
+      # Create object from extracted values.
+      ManyTracks.new(tracks)
+    end
+  end
+end

data/lib/spotify_web_api/models/markets.rb

@@ -0,0 +1,50 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # Markets Model.
+  class Markets < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :markets
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['markets'] = 'markets'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        markets
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(markets = SKIP)
+      @markets = markets unless markets == 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.
+      markets = hash.key?('markets') ? hash['markets'] : SKIP
+
+      # Create object from extracted values.
+      Markets.new(markets)
+    end
+  end
+end

data/lib/spotify_web_api/models/me_albums_request.rb

@@ -0,0 +1,55 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # MeAlbumsRequest Model.
+  class MeAlbumsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A JSON array of the [Spotify
+    # IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+    # `["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]`<br/>A maximum of 50
+    # items can be specified in one request. _**Note**: if the `ids` parameter
+    # is present in the query string, any IDs listed here in the body will be
+    # ignored._
+    # @return [Array[String]]
+    attr_accessor :ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ids'] = 'ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ids = SKIP)
+      @ids = ids unless ids == 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.
+      ids = hash.key?('ids') ? hash['ids'] : SKIP
+
+      # Create object from extracted values.
+      MeAlbumsRequest.new(ids)
+    end
+  end
+end

data/lib/spotify_web_api/models/me_episodes_request.rb

@@ -0,0 +1,52 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # MeEpisodesRequest Model.
+  class MeEpisodesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A JSON array of the [Spotify
+    # IDs](/documentation/web-api/concepts/spotify-uris-ids). <br/>A maximum of
+    # 50 items can be specified in one request. _**Note**: if the `ids`
+    # parameter is present in the query string, any IDs listed here in the body
+    # will be ignored._
+    # @return [Array[String]]
+    attr_accessor :ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ids'] = 'ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ids = nil)
+      @ids = ids
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      ids = hash.key?('ids') ? hash['ids'] : nil
+
+      # Create object from extracted values.
+      MeEpisodesRequest.new(ids)
+    end
+  end
+end

data/lib/spotify_web_api/models/me_episodes_request1.rb

@@ -0,0 +1,54 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # MeEpisodesRequest1 Model.
+  class MeEpisodesRequest1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A JSON array of the [Spotify
+    # IDs](/documentation/web-api/concepts/spotify-uris-ids). <br/>A maximum of
+    # 50 items can be specified in one request. _**Note**: if the `ids`
+    # parameter is present in the query string, any IDs listed here in the body
+    # will be ignored._
+    # @return [Array[String]]
+    attr_accessor :ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ids'] = 'ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ids = SKIP)
+      @ids = ids unless ids == 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.
+      ids = hash.key?('ids') ? hash['ids'] : SKIP
+
+      # Create object from extracted values.
+      MeEpisodesRequest1.new(ids)
+    end
+  end
+end

data/lib/spotify_web_api/models/me_following_request.rb

@@ -0,0 +1,53 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # MeFollowingRequest Model.
+  class MeFollowingRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A JSON array of the artist or user [Spotify
+    # IDs](/documentation/web-api/concepts/spotify-uris-ids).
+    # For example: `{ids:["74ASZWbe4lXaubB36ztrGX", "08td7MxkoHQkXnWAYD8d6Q"]}`.
+    # A maximum of 50 IDs can be sent in one request. _**Note**: if the `ids`
+    # parameter is present in the query string, any IDs listed here in the body
+    # will be ignored._
+    # @return [Array[String]]
+    attr_accessor :ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ids'] = 'ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ids = nil)
+      @ids = ids
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      ids = hash.key?('ids') ? hash['ids'] : nil
+
+      # Create object from extracted values.
+      MeFollowingRequest.new(ids)
+    end
+  end
+end

data/lib/spotify_web_api/models/me_following_request1.rb

@@ -0,0 +1,55 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # MeFollowingRequest1 Model.
+  class MeFollowingRequest1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A JSON array of the artist or user [Spotify
+    # IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+    # `{ids:["74ASZWbe4lXaubB36ztrGX", "08td7MxkoHQkXnWAYD8d6Q"]}`. A maximum of
+    # 50 IDs can be sent in one request. _**Note**: if the `ids` parameter is
+    # present in the query string, any IDs listed here in the body will be
+    # ignored._
+    # @return [Array[String]]
+    attr_accessor :ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ids'] = 'ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ids = SKIP)
+      @ids = ids unless ids == 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.
+      ids = hash.key?('ids') ? hash['ids'] : SKIP
+
+      # Create object from extracted values.
+      MeFollowingRequest1.new(ids)
+    end
+  end
+end

data/lib/spotify_web_api/models/me_player_play_request.rb

@@ -0,0 +1,89 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # MePlayerPlayRequest Model.
+  class MePlayerPlayRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Optional. Spotify URI of the context to play.
+    # Valid contexts are albums, artists & playlists.
+    # `{context_uri:"spotify:album:1Je1IMUlBXcx1Fz0WE7oPT"}`
+    # @return [String]
+    attr_accessor :context_uri
+
+    # Optional. A JSON array of the Spotify track URIs to play.
+    # For example: `{"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh",
+    # "spotify:track:1301WleyT98MSxVHPZCA6M"]}`
+    # @return [Array[String]]
+    attr_accessor :uris
+
+    # Optional. Indicates from where in the context playback should start. Only
+    # available when context_uri corresponds to an album or playlist object
+    # "position" is zero based and can’t be negative. Example: `"offset":
+    # {"position": 5}`
+    # "uri" is a string representing the uri of the item to start at. Example:
+    # `"offset": {"uri": "spotify:track:1301WleyT98MSxVHPZCA6M"}`
+    # @return [Object]
+    attr_accessor :offset
+
+    # Indicates from what position to start playback. Must be a positive number.
+    # Passing in a position that is greater than the length of the track will
+    # cause the player to start playing the next song.
+    # @return [Integer]
+    attr_accessor :position_ms
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['context_uri'] = 'context_uri'
+      @_hash['uris'] = 'uris'
+      @_hash['offset'] = 'offset'
+      @_hash['position_ms'] = 'position_ms'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        context_uri
+        uris
+        offset
+        position_ms
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(context_uri = SKIP, uris = SKIP, offset = SKIP,
+                   position_ms = SKIP)
+      @context_uri = context_uri unless context_uri == SKIP
+      @uris = uris unless uris == SKIP
+      @offset = offset unless offset == SKIP
+      @position_ms = position_ms unless position_ms == 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.
+      context_uri = hash.key?('context_uri') ? hash['context_uri'] : SKIP
+      uris = hash.key?('uris') ? hash['uris'] : SKIP
+      offset = hash.key?('offset') ? hash['offset'] : SKIP
+      position_ms = hash.key?('position_ms') ? hash['position_ms'] : SKIP
+
+      # Create object from extracted values.
+      MePlayerPlayRequest.new(context_uri,
+                              uris,
+                              offset,
+                              position_ms)
+    end
+  end
+end

data/lib/spotify_web_api/models/me_player_request.rb

@@ -0,0 +1,63 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # MePlayerRequest Model.
+  class MePlayerRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A JSON array containing the ID of the device on which playback should be
+    # started/transferred.<br/>For
+    # example:`{device_ids:["74ASZWbe4lXaubB36ztrGX"]}`<br/>_**Note**: Although
+    # an array is accepted, only a single device_id is currently supported.
+    # Supplying more than one will return `400 Bad Request`_
+    # @return [Array[String]]
+    attr_accessor :device_ids
+
+    # **true**: ensure playback happens on new device.<br/>**false** or not
+    # provided: keep the current playback state.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :play
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['device_ids'] = 'device_ids'
+      @_hash['play'] = 'play'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        play
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(device_ids = nil, play = SKIP)
+      @device_ids = device_ids
+      @play = play unless play == 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.
+      device_ids = hash.key?('device_ids') ? hash['device_ids'] : nil
+      play = hash.key?('play') ? hash['play'] : SKIP
+
+      # Create object from extracted values.
+      MePlayerRequest.new(device_ids,
+                          play)
+    end
+  end
+end

data/lib/spotify_web_api/models/me_shows_request.rb

@@ -0,0 +1,55 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # MeShowsRequest Model.
+  class MeShowsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A JSON array of the [Spotify
+    # IDs](https://developer.spotify.com/documentation/web-api/#spotify-uris-and
+    # -ids).  
+    # A maximum of 50 items can be specified in one request. *Note: if the `ids`
+    # parameter is present in the query string, any IDs listed here in the body
+    # will be ignored.*
+    # @return [Array[String]]
+    attr_accessor :ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ids'] = 'ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ids = SKIP)
+      @ids = ids unless ids == 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.
+      ids = hash.key?('ids') ? hash['ids'] : SKIP
+
+      # Create object from extracted values.
+      MeShowsRequest.new(ids)
+    end
+  end
+end

data/lib/spotify_web_api/models/me_tracks_request.rb

@@ -0,0 +1,53 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # MeTracksRequest Model.
+  class MeTracksRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A JSON array of the [Spotify
+    # IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+    # `["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]`<br/>A maximum of 50
+    # items can be specified in one request. _**Note**: if the `ids` parameter
+    # is present in the query string, any IDs listed here in the body will be
+    # ignored._
+    # @return [Array[String]]
+    attr_accessor :ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ids'] = 'ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ids = nil)
+      @ids = ids
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      ids = hash.key?('ids') ? hash['ids'] : nil
+
+      # Create object from extracted values.
+      MeTracksRequest.new(ids)
+    end
+  end
+end

data/lib/spotify_web_api/models/me_tracks_request1.rb

@@ -0,0 +1,55 @@
+# spotify_web_api
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module SpotifyWebApi
+  # MeTracksRequest1 Model.
+  class MeTracksRequest1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A JSON array of the [Spotify
+    # IDs](/documentation/web-api/concepts/spotify-uris-ids). For example:
+    # `["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]`<br/>A maximum of 50
+    # items can be specified in one request. _**Note**: if the `ids` parameter
+    # is present in the query string, any IDs listed here in the body will be
+    # ignored._
+    # @return [Array[String]]
+    attr_accessor :ids
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['ids'] = 'ids'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        ids
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(ids = SKIP)
+      @ids = ids unless ids == 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.
+      ids = hash.key?('ids') ? hash['ids'] : SKIP
+
+      # Create object from extracted values.
+      MeTracksRequest1.new(ids)
+    end
+  end
+end