Add "Add to Queue" endpoint

Author: JMPerez

__test__/spotify-web-api.spec.js

@@ -1678,6 +1678,19 @@ describe('Basic tests', function () {
       expect(that.requests[0].url).toBe('https://api.spotify.com/v1/me/player');
     });
 
+    it('should queue', function () {
+      var callback = sinon.spy();
+      var api = new SpotifyWebApi();
+      api.queue('spotify:track:1301WleyT98MSxVHPZCA6M', callback);
+      that.requests[0].respond(204);
+      expect(that.requests[0].method).toBe('POST');
+      expect(callback.calledWith(null, '')).toBeTruthy();
+      expect(that.requests.length).toBe(1);
+      expect(that.requests[0].url).toBe(
+        'https://api.spotify.com/v1/me/player/queue?uri=spotify%3Atrack%3A1301WleyT98MSxVHPZCA6M'
+      );
+    });
+
     it('should play', function () {
       var callback = sinon.spy();
       var api = new SpotifyWebApi();

src/spotify-web-api.js

@@ -481,7 +481,6 @@ var SpotifyWebApi = (function () {
     return _checkParamsAndPerformRequest(requestData, callback);
   };
 
-
   /**
    * Add the current user as a follower of one playlist.
    * See [Follow a Playlist](https://developer.spotify.com/web-api/follow-playlist/) on
@@ -1650,27 +1649,30 @@ var SpotifyWebApi = (function () {
     return _checkParamsAndPerformRequest(requestData, newOptions, callback);
   };
 
-  
   /**
-   * adds a song to the queue
+   * Add an item to the end of the user’s current playback queue.
    * See [Add an Item to the User's Playback Queue](https://developer.spotify.com/documentation/web-api/reference/player/add-to-queue/) on
    * the Spotify Developer site for more information about the endpoint.
-   */  
-  
+   * @param {string} uri The uri of the item to add to the queue. Must be a track or an episode uri.
+   * @param {Object} options A JSON object with options that can be passed.
+   * @param {function(Object,Object)} callback An optional callback that receives 2 parameters. The first
+   * one is the error object (null if no error), and the second is the value if the request succeeded.
+   * @return {Object} Null if a callback is provided, a `Promise` object otherwise
+   */
   Constr.prototype.queue = function (uri, options, callback) {
     options = options || {};
     var params =
-      'device_id' in options ? { uri: uri, device_id: options.device_id } : {uri: uri};
+      'device_id' in options
+        ? { uri: uri, device_id: options.device_id }
+        : { uri: uri };
     var requestData = {
-      type: 'PUT',
+      type: 'POST',
       url: _baseUri + '/me/player/queue',
       params: params
     };
     return _checkParamsAndPerformRequest(requestData, options, callback);
   };
-  
-  
-  
+
   /**
    * Pause playback on the user’s account.
    * See [Pause a User’s Playback](https://developer.spotify.com/web-api/pause-a-users-playback/) on

src/typings/spotify-api.d.ts

@@ -111,6 +111,10 @@ declare namespace SpotifyApi {
     play?: boolean;
   }
 
+  interface QueueParameterObject {
+    device_id?: string;
+  }
+
   interface TrackRelinkingParameterObject {
     market?: string;
   }

src/typings/spotify-web-api.d.ts

@@ -1395,6 +1395,28 @@ declare namespace SpotifyWebApi {
       callback: VoidResultsCallback
     ): void;
 
+    /**
+     * Add an item to the end of the user’s current playback queue.
+     * See [Add an Item to the User's Playback Queue](https://developer.spotify.com/documentation/web-api/reference/player/add-to-queue/) on
+     * the Spotify Developer site for more information about the endpoint.
+     *
+     * @param {string} uri The uri of the item to add to the queue. Must be a track or an episode uri.
+     * @param {Object} options A JSON object with options that can be passed.
+     * @param {function(Object,Object)} callback An optional callback that receives 2 parameters. The first
+     * one is the error object (null if no error), and the second is the value if the request succeeded.
+     * @return {Object} Null if a callback is provided, a `Promise` object otherwise
+     */
+    queue(
+      uri: string,
+      options?: SpotifyApi.QueueParameterObject
+    ): Promise<void>;
+    getMyCurrentPlayingTrack(
+      uri: string,
+      options: SpotifyApi.QueueParameterObject,
+      callback: VoidResultsCallback
+    ): void;
+    queue(uri: string, callback: VoidResultsCallback): void;
+
     /**
      * Start a new context or resume current playback on the user’s active device.
      * See [Start/Resume a User’s Playback](https://developer.spotify.com/web-api/start-a-users-playback/) on