add ClientPersonalizationApi and ClientProfileApi samples

Author: adamint

samples/src/main/kotlin/private/ClientFollowingApiSample.kt

@@ -26,7 +26,6 @@ fun main() {
     // get all followed artists, limiting 1 each request
     println(api.following.getFollowedArtists(limit = 1).getAllItems().complete().map { it.name })
 
-
     // follow and unfollow, if you weren't previously following, the artist Louane
 
     val isFollowingLouane = api.following.isFollowingArtist("spotify:artist:7wjeXCtRND2ZdKfMJFu6JC").complete()
@@ -36,7 +35,6 @@ fun main() {
 
     if (!isFollowingLouane) api.following.unfollowArtist("spotify:artist:7wjeXCtRND2ZdKfMJFu6JC").complete()
 
-
     // follow and unfollow, if you weren't previously following, the user adamratzman1
 
     val isFollowingAdam = api.following.isFollowingUser("adamratzman1").complete()
@@ -46,7 +44,6 @@ fun main() {
 
     if (!isFollowingAdam) api.following.unfollowUser("adamratzman1").complete()
 
-
     // follow and unfollow, if you weren't previously following, the playlist Today's Top Hits
 
     val isFollowingTodaysTopHits = api.following.isFollowingPlaylist("spotify:playlist:37i9dQZF1DXcBWIGoYBM5M").complete()
@@ -55,5 +52,4 @@ fun main() {
     api.following.followPlaylist("spotify:playlist:37i9dQZF1DXcBWIGoYBM5M").complete()
 
     if (!isFollowingTodaysTopHits) api.following.unfollowPlaylist("spotify:playlist:37i9dQZF1DXcBWIGoYBM5M").complete()
-
 }

samples/src/main/kotlin/private/ClientLibraryApiSample.kt

@@ -15,7 +15,6 @@ fun main() {
         }
     }.build()
 
-
     // get all your saved tracks
     println(api.library.getSavedTracks(limit = 50).getAllItems().complete().map { it.track.name })
 

samples/src/main/kotlin/private/ClientPersonalizationApiSample.kt

@@ -2,6 +2,8 @@
 package private
 
 import com.adamratzman.spotify.SpotifyApi.Companion.spotifyClientApi
+import com.adamratzman.spotify.endpoints.client.ClientPersonalizationApi.TimeRange.LONG_TERM
+import com.adamratzman.spotify.endpoints.client.ClientPersonalizationApi.TimeRange.SHORT_TERM
 
 fun main() {
     // instantiate api
@@ -14,4 +16,9 @@ fun main() {
         }
     }.build()
 
+    // print your top 30 artists over the last few years
+    println(api.personalization.getTopArtists(30, timeRange = LONG_TERM).complete().items.map { it.name })
+
+    // print your top 20 tracks in the last 4 weeks
+    println(api.personalization.getTopTracks(timeRange = SHORT_TERM).complete().items.map { track -> "${track.name} by ${track.artists.joinToString(", ") { it.name }}" })
 }

samples/src/main/kotlin/private/ClientPlayerApiSample.kt

@@ -13,5 +13,4 @@ fun main() {
             tokenString = System.getenv("SPOTIFY_TOKEN_STRING")
         }
     }.build()
-
 }

samples/src/main/kotlin/private/ClientPlaylistApiSample.kt

@@ -13,5 +13,4 @@ fun main() {
             tokenString = System.getenv("SPOTIFY_TOKEN_STRING")
         }
     }.build()
-
 }

samples/src/main/kotlin/private/ClientProfileApiSample.kt

@@ -14,4 +14,8 @@ fun main() {
         }
     }.build()
 
+    // get and print your follower count and, if the associated scope has been authorized, the user's birthday
+    val profile = api.users.getClientProfile().complete()
+
+    println("${profile.followers.total} | ${profile.birthdate}")
 }

src/commonMain/kotlin/com.adamratzman.spotify/endpoints/client/ClientPersonalizationApi.kt

@@ -28,8 +28,18 @@ class ClientPersonalizationApi(api: SpotifyApi<*, *>) : SpotifyEndpoint(api) {
      * @param id the Spotify id of the time frame
      */
     enum class TimeRange(val id: String) {
+        /**
+         * Calculated from several years of data and including all new data as it becomes available
+         */
         LONG_TERM("long_term"),
+        /**
+         * Approximately last 6 months
+         */
         MEDIUM_TERM("medium_term"),
+
+        /**
+         * Approximately last 4 weeks
+         */
         SHORT_TERM("short_term");
 
         override fun toString() = id