@types/spotify-api - npm Package Compare versions

Comparing version 2016.0.28 to 2016.0.29

spotify-api/index.d.ts

@@ -8,2 +8,5 @@ // Type definitions for The Spotify Web API (including changes March 29th 2016)
 // -----------------
+
+// The audio analysis object is not yet in the Object Model at Spotify, therefore it is typed as any in this file.
+
 // TrackObjects and AlbumObjects is specified in the docs as always having the available_markets property,
@@ -41,3 +44,66 @@ // but when it is sent in https://developer.spotify.com/web-api/console/get-current-user-saved-tracks
 
+    /**
+     * Object for use in Recommendations Based on Seeds.
+     * See: [Recommendations Based on Seeds](https://developer.spotify.com/web-api/get-recommendations/)
+     *
+     * @limit q Optional. The target size of the list of recommended tracks. For seeds with unusually small pools or when highly restrictive filtering is applied, it may be impossible to generate the requested number of recommended tracks. Debugging information for such cases is available in the response. Default: 20. Minimum: 1. Maximum: 100.
+     * @market q Optional. An ISO 3166-1 alpha-2 country code. Provide this parameter if you want to apply Track Relinking. Because min_*, max_* and target_* are applied to pools before relinking, the generated results may not precisely match the filters applied. Original, non-relinked tracks are available via the linked_from attribute of the relinked track response.
+     * @max_ q Optional. Multiple values. For each tunable track attribute, a hard ceiling on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, max_instrumentalness=0.35 would filter out most tracks that are likely to be instrumental.
+     * @min_ q Optional. Multiple values. For each tunable track attribute, a hard floor on the selected track attribute’s value can be provided. See tunable track attributes below for the list of available options. For example, min_tempo=140 would restrict results to only those tracks with a tempo of greater than 140 beats per minute.
+     * @seed_artists q A comma separated list of Spotify IDs for seed artists. Up to 5 seed values may be provided in any combination of seed_artists, seed_tracks and seed_genres.
+     * @seed_genres q A comma separated list of any genres in the set of available genre seeds. Up to 5 seed values may be provided in any combination of seed_artists, seed_tracks and seed_genres.
+     * @seed_tracks q A comma separated list of Spotify IDs for a seed track. Up to 5 seed values may be provided in any combination of seed_artists, seed_tracks and seed_genres.
+     * @target_ q Optional. Multiple values. For each of the tunable track attributes (below) a target value may be provided. Tracks with the attribute values nearest to the target values will be preferred. For example, you might request target_energy=0.6 and target_danceability=0.8. All target values will be weighed equally in ranking results.
+     */
+    interface RecommendationsOptionsObject {
+        limit?: number,
+        market?: string,
+        max_acousticness?: number,
+        max_danceability?: number,
+        max_duration_ms?: number,
+        max_energy?: number,
+        max_instrumentalness?: number,
+        max_key?: number,
+        max_liveness?: number,
+        max_loudness?: number,
+        max_mode?: number,
+        max_popularity?: number,
+        max_speechiness?: number,
+        max_tempo?: number,
+        max_time_signature?: number,
+        max_valence?: number,
+        min_acousticness?: number,
+        min_danceability?: number,
+        min_duration_ms?: number,
+        min_energy?: number,
+        min_instrumentalness?: number,
+        min_key?: number,
+        min_liveness?: number,
+        min_loudness?: number,
+        min_mode?: number,
+        min_popularity?: number,
+        min_speechiness?: number,
+        min_tempo?: number,
+        min_time_signature?: number,
+        min_valence?: number,
+        seed_artists?: string,   // Comma separated string
+        seed_genres?: string,   // Comma separated string
+        seed_tracks?: string,   // Comma separated string
+        target_acousticness?: number
+        target_danceability?: number
+        target_duration_ms?: number
+        target_energy?: number
+        target_instrumentalness?: number
+        target_key?: number
+        target_liveness?: number
+        target_loudness?: number
+        target_mode?: number
+        target_popularity?: number
+        target_speechiness?: number
+        target_tempo?: number
+        target_time_signature?: number
+        target_valence?: number
+    }
 
+
     //
@@ -67,3 +133,5 @@ // Responses from the Spotify Web API in the same order as in the API endpoint docs seen here:
      * Get an Album
+     * 
      * GET /v1/albums/{id}
+     * https://developer.spotify.com/web-api/get-album/
      */
@@ -74,3 +142,5 @@ interface SingleAlbumResponse extends AlbumObjectFull {}
      * Get Several Albums
-     * GET /v1/albums
+     * 
+     * GET /v1/albums?ids={ids}
+     * https://developer.spotify.com/web-api/get-several-albums/ 
      */
@@ -83,3 +153,5 @@ interface MultipleAlbumsResponse {
      * Get an Album’s Tracks
+     * 
      * GET /v1/albums/{id}/tracks
+     * https://developer.spotify.com/web-api/get-albums-tracks/
      */
@@ -90,3 +162,5 @@ interface AlbumTracksResponse extends PagingObject<TrackObjectSimplified> {}
      * Get an Artist
+     * 
      * GET /v1/artists/{id}
+     * https://developer.spotify.com/web-api/get-artist/
      */
@@ -97,3 +171,5 @@ interface SingleArtistResponse extends ArtistObjectFull {}
      * Get Several Artists
-     * GET /v1/artists
+     * 
+     * /v1/artists?ids={ids} 
+     * https://developer.spotify.com/web-api/get-several-artists/
      */
@@ -106,3 +182,5 @@ interface MultipleArtistsResponse {
      * Get an Artist’s Albums
+     * 
      * GET /v1/artists/{id}/albums
+     * https://developer.spotify.com/web-api/get-artists-albums/
      */
@@ -113,3 +191,5 @@ interface ArtistsAlbumsResponse extends PagingObject<AlbumObjectSimplified> {}
      * Get an Artist’s Top Tracks
+     * 
      * GET /v1/artists/{id}/top-tracks
+     * https://developer.spotify.com/web-api/get-artists-top-tracks/
      */
@@ -122,3 +202,5 @@ interface ArtistsTopTracksResponse {
      * Get an Artist’s Related Artists
+     * 
      * GET /v1/artists/{id}/related-artists
+     * https://developer.spotify.com/web-api/get-related-artists/
      */
@@ -130,4 +212,17 @@ interface ArtistsRelatedArtistsResponse {
     /**
+     * Get Audio Analysis for a Track
+     * 
+     * GET /v1/audio-analysis/{id}
+     * https://developer.spotify.com/web-api/get-audio-analysis/
+     * 
+     * At the time of typing, the Audio Analysis Object is absent from the Object Model, so it is typed as any.
+     * Object Model: https://developer.spotify.com/web-api/object-model/
+     */
+    interface AudioAnalysisResponse extends Object {}
+
+    /**
      * Get audio features for a track
+     * 
      * GET /v1/audio-features/{id}
+     * https://developer.spotify.com/web-api/get-audio-features/
      */
@@ -138,3 +233,5 @@ interface AudioFeaturesResponse extends AudioFeaturesObject {}
      * Get audio features for several tracks
-     * GET /v1/audio-features
+     * 
+     * GET /v1/audio-features?ids={ids}
+     * https://developer.spotify.com/get-several-audio-features/
      */
@@ -147,3 +244,5 @@ interface MultipleAudioFeaturesResponse {
      * Get a list of featured playlists
+     * 
      * GET /v1/browse/featured-playlists
+     * https://developer.spotify.com/web-api/get-list-featured-playlists/
      */
@@ -157,3 +256,5 @@ interface ListOfFeaturedPlaylistsResponse {
      * Get a list of new releases
+     * 
      * GET /v1/browse/new-releases
+     * https://developer.spotify.com/web-api/get-list-new-releases/
      */
@@ -167,3 +268,5 @@ interface ListOfNewReleasesResponse {
      * Get a list of categories
+     * 
      * GET /v1/browse/categories
+     * https://developer.spotify.com/web-api/get-list-categories/
      */
@@ -176,3 +279,5 @@ interface MultipleCategoriesResponse {
      * Get a category
-     * GET /v1/browse/categories/{category_id}
+     * 
+     * GET /v1/browse/categories/{id}
+     * https://developer.spotify.com/web-api/get-category/
      */
@@ -183,3 +288,5 @@ interface SingleCategoryResponse extends CategoryObject {}
      * Get a categorys playlists
+     * 
      * GET /v1/browse/categories/{id}/playlists
+     * https://developer.spotify.com/web-api/get-categorys-playlists/
      */
@@ -192,3 +299,5 @@ interface CategoryPlaylistsReponse {
      * Get Current User’s Profile
+     * 
      * GET /v1/me
+     * https://developer.spotify.com/web-api/get-current-users-profile/
      */
@@ -199,3 +308,5 @@ interface CurrentUsersProfileResponse extends UserObjectPrivate {}
      * Get User’s Followed Artists
-     * GET /v1/me/following?type=artist
+     * 
+     * GET /v1/me/following
+     * https://developer.spotify.com/web-api/get-followed-artists/
      */
@@ -208,3 +319,5 @@ interface UsersFollowedArtistsResponse {
      * Follow artists or users
+     * 
      * PUT /v1/me/following
+     * https://developer.spotify.com/web-api/follow-artists-users/
      */
@@ -215,3 +328,5 @@ interface FollowArtistsOrUsersResponse extends VoidResponse {}
      * Unfollow artists or users
+     * 
      * DELETE /v1/me/following
+     * https://developer.spotify.com/web-api/unfollow-artists-users/
      */
@@ -222,3 +337,5 @@ interface UnfollowArtistsOrUsersResponse extends VoidResponse {}
      * Check if User Follows Users or Artists
+     * 
      * GET /v1/me/following/contains
+     * https://developer.spotify.com/web-api/check-current-user-follows/
      */
@@ -229,3 +346,5 @@ interface UserFollowsUsersOrArtistsResponse extends Array<boolean> {}
      * Follow a Playlist
+     * 
      * PUT /v1/users/{owner_id}/playlists/{playlist_id}/followers
+     * https://developer.spotify.com/web-api/follow-playlist/
      */
@@ -236,3 +355,5 @@ interface FollowPlaylistReponse extends VoidResponse {}
      * Unfollow a Playlist
+     * 
      * DELETE /v1/users/{owner_id}/playlists/{playlist_id}/followers
+     * https://developer.spotify.com/web-api/unfollow-playlist/
      */
@@ -243,3 +364,5 @@ interface UnfollowPlaylistReponse extends VoidResponse {}
      * Save tracks for user
+     * 
      * PUT /v1/me/tracks?ids={ids}
+     * https://developer.spotify.com/web-api/save-tracks-user/
      */
@@ -250,3 +373,5 @@ interface SaveTracksForUserResponse extends VoidResponse {}
      * Get user's saved tracks
+     * 
      * GET /v1/me/tracks
+     * https://developer.spotify.com/web-api/get-users-saved-tracks/
      */
@@ -257,3 +382,5 @@ interface UsersSavedTracksResponse extends PagingObject<SavedTrackObject> {}
      * Remove User’s Saved Tracks
+     * 
      * DELETE /v1/me/tracks?ids={ids}
+     * https://developer.spotify.com/web-api/remove-tracks-user/
      */
@@ -264,3 +391,5 @@ interface RemoveUsersSavedTracksResponse extends VoidResponse {}
      * Check User’s Saved Tracks
-     * GET /v1/me/tracks/contains
+     * 
+     * GET /v1/me/tracks/contains?ids={ids}
+     * https://developer.spotify.com/web-api/check-users-saved-tracks/
      */
@@ -271,3 +400,5 @@ interface CheckUsersSavedTracksResponse extends Array<boolean> {}
      * Save albums for user
+     * 
      * PUT /v1/me/albums?ids={ids}
+     * https://developer.spotify.com/web-api/save-albums-user/
      */
@@ -278,9 +409,13 @@ interface SaveAlbumsForUserResponse extends VoidResponse {}
      * Get user's saved albums
+     * 
      * GET /v1/me/albums
+     * https://developer.spotify.com/web-api/get-users-saved-albums/
      */
-    interface UsersSavedAlbumsResponse extends PagingObject<AlbumObjectFull> {}
+    interface UsersSavedAlbumsResponse extends PagingObject<SavedAlbumObject> {}
 
     /**
      * Remove Albums for Current User
+     * 
      * DELETE /v1/me/albums?ids={ids}
+     * https://developer.spotify.com/web-api/remove-albums-user/
      */
@@ -291,3 +426,5 @@ interface RemoveAlbumsForUserResponse extends VoidResponse {}
      * Check user's saved albums
-     * DELETE /v1/me/albums/contains?ids={ids}
+     * 
+     * GET /v1/me/albums/contains?ids={ids}
+     * https://developer.spotify.com/web-api/check-users-saved-albums/
      */
@@ -297,16 +434,22 @@ interface CheckUserSavedAlbumsResponse extends Array<boolean> {}
     /**
-     * Get a User’s Top Artists and Tracks
+     * Get a User’s Top Artists and Tracks (Note: This is only Artists)
+     * 
      * GET /v1/me/top/{type}
+     * https://developer.spotify.com/web-api/get-users-top-artists-and-tracks/
      */
-    interface UsersTopTracksResponse extends PagingObject<TrackObjectFull> {}
+    interface UsersTopArtistsResponse extends PagingObject<ArtistObjectFull> {}
 
     /**
-     * Get a User’s Top Artists and Tracks
+     * Get a User’s Top Artists and Tracks (Note: This is only Tracks)
+     * 
      * GET /v1/me/top/{type}
+     * https://developer.spotify.com/web-api/get-users-top-artists-and-tracks/
      */
-    interface UsersTopArtistsResponse extends PagingObject<ArtistObjectFull> {}
+    interface UsersTopTracksResponse extends PagingObject<TrackObjectFull> {}
 
     /**
      * Get recommendations based on seeds
+     * 
      * GET /v1/recommendations
+     * https://developer.spotify.com/get-recommendations/
      */
@@ -316,4 +459,16 @@ interface RecommendationsFromSeedsResponse extends RecommendationsObject {}
     /**
+     * Get available genre seeds
+     * 
+     * GET /v1/recommendations/available-genre-seeds
+     * https://developer.spotify.com/web-api/get-recommendations/#available-genre-seeds
+     */
+    interface AvailableGenreSeedsResponse {
+        "genres": string[]
+    }
+
+    /**
      * Search for an album
+     * 
      * GET /v1/search?type=album
+     * https://developer.spotify.com/web-api/search-item/
      */
@@ -326,3 +481,5 @@ interface AlbumSearchResponse {
      * Search for an artist
+     * 
      * GET /v1/search?type=artist
+     * https://developer.spotify.com/web-api/search-item/
      */
@@ -335,3 +492,5 @@ interface ArtistSearchResponse {
      * Search for a playlist
+     * 
      * GET /v1/search?type=playlist
+     * https://developer.spotify.com/web-api/search-item/
      */
@@ -344,3 +503,5 @@ interface PlaylistSearchResponse {
      * Search for a track
+     * 
      * GET /v1/search?type=track
+     * https://developer.spotify.com/web-api/search-item/
      */
@@ -353,3 +514,5 @@ interface TrackSearchResponse {
      * Get a track
+     * 
      * GET /v1/tracks/{id}
+     * https://developer.spotify.com/web-api/get-track/
      */
@@ -360,3 +523,5 @@ interface SingleTrackResponse extends TrackObjectFull {}
      * Get multiple tracks
+     * 
      * GET /v1/tracks?ids={ids}
+     * https://developer.spotify.com/web-api/get-several-tracks/
      */
@@ -369,3 +534,5 @@ interface MultipleTracksResponse {
      * Get user profile
+     * 
      * GET /v1/users/{user_id}
+     * https://developer.spotify.com/web-api/get-users-profile/
      */
@@ -376,3 +543,5 @@ interface UserProfileResponse extends UserObjectPublic {}
      * Get a list of a user's playlists
+     * 
      * GET /v1/users/{user_id}/playlists
+     * https://developer.spotify.com/web-api/get-list-users-playlists/
      */
@@ -383,3 +552,5 @@ interface ListOfUsersPlaylistsResponse extends PagingObject<PlaylistObjectSimplified> {}
      * Get a list of the current user's playlists
+     * 
      * GET /v1/me/playlists
+     * https://developer.spotify.com/web-api/get-list-users-playlists/
      */
@@ -390,3 +561,5 @@ interface ListOfCurrentUsersPlaylistsResponse extends PagingObject<PlaylistObjectSimplified> {}
      * Get a playlist
+     * 
      * GET /v1/users/{user_id}/playlists/{playlist_id}
+     * https://developer.spotify.com/web-api/get-playlist/
      */
@@ -397,3 +570,5 @@ interface SinglePlaylistResponse extends PlaylistObjectFull {}
      * Get a playlist's tracks
+     * 
      * GET /v1/users/{user_id}/playlists/{playlist_id}/tracks
+     * https://developer.spotify.com/web-api/get-playlists-tracks/
      */
@@ -404,3 +579,5 @@ interface PlaylistTrackResponse extends PagingObject<PlaylistTrackObject> {}
      * Create a Playlist
+     * 
      * POST /v1/users/{user_id}/playlists
+     * https://developer.spotify.com/web-api/create-playlist/
      */
@@ -411,3 +588,5 @@ interface CreatePlaylistResponse extends PlaylistObjectFull {}
      * Change a Playlist’s Details
+     * 
      * PUT /v1/users/{user_id}/playlists/{playlist_id}
+     * https://developer.spotify.com/web-api/change-playlist-details/
      */
@@ -418,3 +597,5 @@ interface ChangePlaylistDetailsReponse extends VoidResponse {}
      * Add Tracks to a Playlist
+     * 
      * POST /v1/users/{user_id}/playlists/{playlist_id}/tracks
+     * https://developer.spotify.com/web-api/add-tracks-to-playlist/
      */
@@ -425,3 +606,5 @@ interface AddTracksToPlaylistResponse extends PlaylistSnapshotResponse {}
      * Remove Tracks from a Playlist
+     * 
      * DELETE /v1/users/{user_id}/playlists/{playlist_id}/tracks
+     * https://developer.spotify.com/web-api/remove-tracks-playlist/
      */
@@ -432,3 +615,5 @@ interface RemoveTracksFromPlaylistResponse extends PlaylistSnapshotResponse {}
      * Reorder a Playlist’s Tracks
+     * 
      * PUT /v1/users/{user_id}/playlists/{playlist_id}/tracks
+     * https://developer.spotify.com/web-api/reorder-playlists-tracks/
      */
@@ -439,3 +624,5 @@ interface ReorderPlaylistTracksResponse extends PlaylistSnapshotResponse {}
      * Replace a Playlist’s Tracks
+     * 
      * PUT /v1/users/{user_id}/playlists/{playlist_id}/tracks
+     * https://developer.spotify.com/web-api/replace-playlists-tracks/
      */
@@ -446,3 +633,5 @@ interface ReplacePlaylistTracksResponse extends VoidResponse {}
      * Check if Users Follow a Playlist
+     * 
      * GET /v1/users/{user_id}/playlists/{playlist_id}/followers/contains
+     * https://developer.spotify.com/web-api/check-user-following-playlist/
      */
@@ -449,0 +638,0 @@ interface UsersFollowPlaylistReponse extends Array<boolean> {}

spotify-api/package.json

 {
     "name": "@types/spotify-api",
-    "version": "2016.0.28",
+    "version": "2016.0.29",
     "description": "TypeScript definitions for The Spotify Web API (including changes March 29th 2016)",
@@ -16,3 +16,3 @@ "license": "MIT",
     "typings": "index.d.ts",
-    "typesPublisherContentHash": "cf42726bf70d95ac4119096df85f660488ba4bce80f427939f205627d6a7bb0e"
+    "typesPublisherContentHash": "6711d0c09a296e542735625a0598e905cc50925bf4f8833791a2829bf6c0ed40"
 }

spotify-api/README.md

@@ -11,3 +11,3 @@ # Installation
 Additional Details
- * Last updated: Wed, 26 Oct 2016 19:23:31 GMT
+ * Last updated: Mon, 14 Nov 2016 19:35:02 GMT
  * File structure: Global
@@ -14,0 +14,0 @@ * Library Dependencies: none

spotify-api/types-metadata.json

@@ -6,4 +6,4 @@ {
     "moduleDependencies": [],
-    "libraryMajorVersion": "2016",
-    "libraryMinorVersion": "0",
+    "libraryMajorVersion": 2016,
+    "libraryMinorVersion": 0,
     "libraryName": "The Spotify Web API (including changes March 29th 2016)",
@@ -21,3 +21,3 @@ "typingsPackageName": "spotify-api",
     "hasPackageJson": false,
-    "contentHash": "cf42726bf70d95ac4119096df85f660488ba4bce80f427939f205627d6a7bb0e"
+    "contentHash": "6711d0c09a296e542735625a0598e905cc50925bf4f8833791a2829bf6c0ed40"
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

32092

increased by38.74%

Lines of code

867

increased by27.88%

No dependency changes