run ktlint & dokka

Signed-off-by: Adam Ratzman <[email protected]>

Author: adamint

docs/md/-spotify-kotlin-wrapper/alltypes/index.md

@@ -0,0 +1,94 @@
+
+
+### All Types
+
+| Name | Summary |
+|---|---|
+| [com.adamratzman.spotify.utils.AbstractPagingObject](../com.adamratzman.spotify.utils/-abstract-paging-object/index.md) |  |
+| [com.adamratzman.spotify.utils.Album](../com.adamratzman.spotify.utils/-album/index.md) |  |
+| [com.adamratzman.spotify.endpoints.public.AlbumAPI](../com.adamratzman.spotify.endpoints.public/-album-a-p-i/index.md) | Endpoints for retrieving information about one or more albums from the Spotify catalog. |
+| [com.adamratzman.spotify.utils.AlbumResultType](../com.adamratzman.spotify.utils/-album-result-type/index.md) | Album type |
+| [com.adamratzman.spotify.utils.AlbumURI](../com.adamratzman.spotify.utils/-album-u-r-i/index.md) | Represents a Spotify **Album** URI, parsed from either a Spotify ID or taken from an endpoint. |
+| [com.adamratzman.spotify.utils.Artist](../com.adamratzman.spotify.utils/-artist/index.md) |  |
+| [com.adamratzman.spotify.utils.ArtistURI](../com.adamratzman.spotify.utils/-artist-u-r-i/index.md) | Represents a Spotify **Artist** URI, parsed from either a Spotify ID or taken from an endpoint. |
+| [com.adamratzman.spotify.endpoints.public.ArtistsAPI](../com.adamratzman.spotify.endpoints.public/-artists-a-p-i/index.md) | Endpoints for retrieving information about one or more artists from the Spotify catalog. |
+| [com.adamratzman.spotify.utils.AudioAnalysis](../com.adamratzman.spotify.utils/-audio-analysis/index.md) |  |
+| [com.adamratzman.spotify.utils.AudioAnalysisMeta](../com.adamratzman.spotify.utils/-audio-analysis-meta/index.md) |  |
+| [com.adamratzman.spotify.utils.AudioFeatures](../com.adamratzman.spotify.utils/-audio-features/index.md) |  |
+| [com.adamratzman.spotify.utils.AudioSection](../com.adamratzman.spotify.utils/-audio-section/index.md) |  |
+| [com.adamratzman.spotify.utils.AudioSegment](../com.adamratzman.spotify.utils/-audio-segment/index.md) |  |
+| [com.adamratzman.spotify.utils.BadRequestException](../com.adamratzman.spotify.utils/-bad-request-exception/index.md) |  |
+| [com.adamratzman.spotify.endpoints.public.BrowseAPI](../com.adamratzman.spotify.endpoints.public/-browse-a-p-i/index.md) | Endpoints for getting playlists and new album releases featured on Spotify’s Browse tab. |
+| [com.adamratzman.spotify.endpoints.client.ClientFollowingAPI](../com.adamratzman.spotify.endpoints.client/-client-following-a-p-i/index.md) | These endpoints allow you manage the artists, users and playlists that a Spotify user follows. |
+| [com.adamratzman.spotify.endpoints.client.ClientLibraryAPI](../com.adamratzman.spotify.endpoints.client/-client-library-a-p-i/index.md) | Endpoints for retrieving information about, and managing, tracks that the current user has saved in their “Your Music” library. |
+| [com.adamratzman.spotify.endpoints.client.ClientPersonalizationAPI](../com.adamratzman.spotify.endpoints.client/-client-personalization-a-p-i/index.md) | Endpoints for retrieving information about the user’s listening habits. |
+| [com.adamratzman.spotify.endpoints.client.ClientPlayerAPI](../com.adamratzman.spotify.endpoints.client/-client-player-a-p-i/index.md) | These endpoints allow for viewing and controlling user playback. Please view [the official documentation](https://developer.spotify.com/web-api/working-with-connect/) for more information on how this works. This is in beta and is available for **premium users only**. Endpoints are **not** guaranteed to work |
+| [com.adamratzman.spotify.endpoints.client.ClientPlaylistAPI](../com.adamratzman.spotify.endpoints.client/-client-playlist-a-p-i/index.md) | Endpoints for retrieving information about a user’s playlists and for managing a user’s playlists. |
+| [com.adamratzman.spotify.endpoints.client.ClientUserAPI](../com.adamratzman.spotify.endpoints.client/-client-user-a-p-i/index.md) | Endpoints for retrieving information about a user’s profile. |
+| [com.adamratzman.spotify.utils.Context](../com.adamratzman.spotify.utils/-context/index.md) |  |
+| [com.adamratzman.spotify.utils.CurrentlyPlayingContext](../com.adamratzman.spotify.utils/-currently-playing-context/index.md) |  |
+| [com.adamratzman.spotify.utils.CurrentlyPlayingObject](../com.adamratzman.spotify.utils/-currently-playing-object/index.md) |  |
+| [com.adamratzman.spotify.utils.Cursor](../com.adamratzman.spotify.utils/-cursor/index.md) | The cursor to use as key to find the next page of items. |
+| [com.adamratzman.spotify.utils.CursorBasedPagingObject](../com.adamratzman.spotify.utils/-cursor-based-paging-object/index.md) | The cursor-based paging object is a container for a set of objects. It contains a key called items (whose value is an array of the requested objects) along with other keys like next and cursors that can be useful in future calls. |
+| [com.adamratzman.spotify.utils.Device](../com.adamratzman.spotify.utils/-device/index.md) |  |
+| [com.adamratzman.spotify.utils.ErrorObject](../com.adamratzman.spotify.utils/-error-object/index.md) | Contains a parsed error from Spotify |
+| [com.adamratzman.spotify.utils.ErrorResponse](../com.adamratzman.spotify.utils/-error-response/index.md) | Wrapper around [ErrorObject](../com.adamratzman.spotify.utils/-error-object/index.md) |
+| [com.adamratzman.spotify.utils.FeaturedPlaylists](../com.adamratzman.spotify.utils/-featured-playlists/index.md) | Spotify featured playlists (on the Browse tab) |
+| [com.adamratzman.spotify.utils.Followers](../com.adamratzman.spotify.utils/-followers/index.md) | Spotify user's followers |
+| [com.adamratzman.spotify.endpoints.public.FollowingAPI](../com.adamratzman.spotify.endpoints.public/-following-a-p-i/index.md) | This endpoint allow you check the playlists that a Spotify user follows. |
+| [com.adamratzman.spotify.endpoints.client.LibraryType](../com.adamratzman.spotify.endpoints.client/-library-type/index.md) | Type of object in a user's Spotify library |
+| [com.adamratzman.spotify.utils.Linkable](../com.adamratzman.spotify.utils/-linkable/index.md) | Allow for track relinking |
+| [com.adamratzman.spotify.utils.LinkedTrack](../com.adamratzman.spotify.utils/-linked-track/index.md) | Represents a [relinked track](https://github.com/adamint/spotify-web-api-kotlin/blob/master/README.md#track-relinking). This is playable in the searched market. If null, the API result is playable in the market. |
+| [com.adamratzman.spotify.utils.Market](../com.adamratzman.spotify.utils/-market/index.md) | Represents Spotify markets (countries + distinctive territories) |
+| [com.adamratzman.spotify.utils.PagingObject](../com.adamratzman.spotify.utils/-paging-object/index.md) | The offset-based paging object is a container for a set of objects. It contains a key called items (whose value is an array of the requested objects) along with other keys like previous, next and limit that can be useful in future calls. |
+| [com.adamratzman.spotify.utils.PagingTraversalType](../com.adamratzman.spotify.utils/-paging-traversal-type/index.md) |  |
+| [com.adamratzman.spotify.utils.PlayHistory](../com.adamratzman.spotify.utils/-play-history/index.md) |  |
+| [com.adamratzman.spotify.utils.PlayHistoryContext](../com.adamratzman.spotify.utils/-play-history-context/index.md) |  |
+| [com.adamratzman.spotify.utils.Playlist](../com.adamratzman.spotify.utils/-playlist/index.md) |  |
+| [com.adamratzman.spotify.utils.PlaylistTrack](../com.adamratzman.spotify.utils/-playlist-track/index.md) |  |
+| [com.adamratzman.spotify.utils.PlaylistTrackInfo](../com.adamratzman.spotify.utils/-playlist-track-info/index.md) | A collection containing a link ( href ) to the Web API endpoint where full details of the playlist’s tracks can be retrieved, along with the total number of tracks in the playlist. |
+| [com.adamratzman.spotify.utils.PlaylistURI](../com.adamratzman.spotify.utils/-playlist-u-r-i/index.md) | Represents a Spotify **Playlist** URI, parsed from either a Spotify ID or taken from an endpoint. |
+| [com.adamratzman.spotify.endpoints.public.PlaylistsAPI](../com.adamratzman.spotify.endpoints.public/-playlists-a-p-i/index.md) | Endpoints for retrieving information about a user’s playlists |
+| [com.adamratzman.spotify.utils.RecommendationResponse](../com.adamratzman.spotify.utils/-recommendation-response/index.md) |  |
+| [com.adamratzman.spotify.utils.RecommendationSeed](../com.adamratzman.spotify.utils/-recommendation-seed/index.md) | Seed from which the recommendation was constructed |
+| [com.adamratzman.spotify.utils.RelinkingAvailableResponse](../com.adamratzman.spotify.utils/-relinking-available-response/index.md) |  |
+| [com.adamratzman.spotify.utils.Restrictions](../com.adamratzman.spotify.utils/-restrictions/index.md) | Contains an explanation of why a track is not available |
+| [com.adamratzman.spotify.utils.SavedAlbum](../com.adamratzman.spotify.utils/-saved-album/index.md) |  |
+| [com.adamratzman.spotify.utils.SavedTrack](../com.adamratzman.spotify.utils/-saved-track/index.md) |  |
+| [com.adamratzman.spotify.endpoints.public.SearchAPI](../com.adamratzman.spotify.endpoints.public/-search-a-p-i/index.md) | Get Spotify catalog information about artists, albums, tracks or playlists that match a keyword string. |
+| [com.adamratzman.spotify.utils.SimpleAlbum](../com.adamratzman.spotify.utils/-simple-album/index.md) |  |
+| [com.adamratzman.spotify.utils.SimpleArtist](../com.adamratzman.spotify.utils/-simple-artist/index.md) |  |
+| [com.adamratzman.spotify.utils.SimplePlaylist](../com.adamratzman.spotify.utils/-simple-playlist/index.md) |  |
+| [com.adamratzman.spotify.utils.SimpleTrack](../com.adamratzman.spotify.utils/-simple-track/index.md) |  |
+| [com.adamratzman.spotify.main.SpotifyAPI](../com.adamratzman.spotify.main/-spotify-a-p-i/index.md) |  |
+| [com.adamratzman.spotify.main.SpotifyApiBuilder](../com.adamratzman.spotify.main/-spotify-api-builder/index.md) |  |
+| [com.adamratzman.spotify.main.SpotifyApiBuilderJava](../com.adamratzman.spotify.main/-spotify-api-builder-java/index.md) |  |
+| [com.adamratzman.spotify.main.SpotifyAppAPI](../com.adamratzman.spotify.main/-spotify-app-a-p-i/index.md) |  |
+| [com.adamratzman.spotify.utils.SpotifyCategory](../com.adamratzman.spotify.utils/-spotify-category/index.md) | Spotify music category |
+| [com.adamratzman.spotify.main.SpotifyClientAPI](../com.adamratzman.spotify.main/-spotify-client-a-p-i/index.md) |  |
+| [com.adamratzman.spotify.utils.SpotifyCopyright](../com.adamratzman.spotify.utils/-spotify-copyright/index.md) | Describes an album's copyright |
+| [com.adamratzman.spotify.main.SpotifyCredentials](../com.adamratzman.spotify.main/-spotify-credentials/index.md) |  |
+| [com.adamratzman.spotify.main.SpotifyCredentialsBuilder](../com.adamratzman.spotify.main/-spotify-credentials-builder/index.md) |  |
+| [com.adamratzman.spotify.utils.SpotifyEndpoint](../com.adamratzman.spotify.utils/-spotify-endpoint/index.md) |  |
+| [com.adamratzman.spotify.main.SpotifyException](../com.adamratzman.spotify.main/-spotify-exception/index.md) |  |
+| [com.adamratzman.spotify.utils.SpotifyImage](../com.adamratzman.spotify.utils/-spotify-image/index.md) | A Spotify image |
+| [com.adamratzman.spotify.main.SpotifyLogger](../com.adamratzman.spotify.main/-spotify-logger/index.md) |  |
+| [com.adamratzman.spotify.utils.SpotifyPublicUser](../com.adamratzman.spotify.utils/-spotify-public-user/index.md) |  |
+| [com.adamratzman.spotify.main.SpotifyRestAction](../com.adamratzman.spotify.main/-spotify-rest-action/index.md) |  |
+| [com.adamratzman.spotify.main.SpotifyRestActionPaging](../com.adamratzman.spotify.main/-spotify-rest-action-paging/index.md) |  |
+| [com.adamratzman.spotify.main.SpotifyScope](../com.adamratzman.spotify.main/-spotify-scope/index.md) |  |
+| [com.adamratzman.spotify.endpoints.client.SpotifyTrackPositions](../com.adamratzman.spotify.endpoints.client/-spotify-track-positions/index.md) | Represents the positions inside a playlist's items list of where to locate the track |
+| [com.adamratzman.spotify.utils.SpotifyUri](../com.adamratzman.spotify.utils/-spotify-uri/index.md) | Represents a Spotify URI, parsed from either a Spotify ID or taken from an endpoint. |
+| [com.adamratzman.spotify.utils.SpotifyUriException](../com.adamratzman.spotify.utils/-spotify-uri-exception/index.md) |  |
+| [com.adamratzman.spotify.main.SpotifyUserAuthorizationBuilder](../com.adamratzman.spotify.main/-spotify-user-authorization-builder/index.md) | Authentication methods. |
+| [com.adamratzman.spotify.utils.SpotifyUserInformation](../com.adamratzman.spotify.utils/-spotify-user-information/index.md) |  |
+| [com.adamratzman.spotify.utils.TimeInterval](../com.adamratzman.spotify.utils/-time-interval/index.md) |  |
+| [com.adamratzman.spotify.utils.Token](../com.adamratzman.spotify.utils/-token/index.md) | Represents a Spotify Token, retrieved through instantiating a new [SpotifyAPI](#) |
+| [com.adamratzman.spotify.utils.Track](../com.adamratzman.spotify.utils/-track/index.md) |  |
+| [com.adamratzman.spotify.utils.TrackAnalysis](../com.adamratzman.spotify.utils/-track-analysis/index.md) |  |
+| [com.adamratzman.spotify.utils.TrackURI](../com.adamratzman.spotify.utils/-track-u-r-i/index.md) | Represents a Spotify **Track** URI, parsed from either a Spotify ID or taken from an endpoint. |
+| [com.adamratzman.spotify.endpoints.public.TracksAPI](../com.adamratzman.spotify.endpoints.public/-tracks-a-p-i/index.md) | Endpoints for retrieving information about one or more tracks from the Spotify catalog. |
+| [com.adamratzman.spotify.endpoints.public.TuneableTrackAttribute](../com.adamratzman.spotify.endpoints.public/-tuneable-track-attribute/index.md) | Describes a track attribute |
+| [com.adamratzman.spotify.endpoints.public.UserAPI](../com.adamratzman.spotify.endpoints.public/-user-a-p-i/index.md) | Endpoints for retrieving information about a user’s profile. |
+| [com.adamratzman.spotify.utils.UserURI](../com.adamratzman.spotify.utils/-user-u-r-i/index.md) | Represents a Spotify **User** URI, parsed from either a Spotify ID or taken from an endpoint. |
+| [com.adamratzman.spotify.utils.VideoThumbnail](../com.adamratzman.spotify.utils/-video-thumbnail/index.md) |  |

docs/md/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-following-a-p-i/-init-.md

@@ -0,0 +1,8 @@
+[SpotifyKotlinWrapper](../../index.md) / [com.adamratzman.spotify.endpoints.client](../index.md) / [ClientFollowingAPI](index.md) / [<init>](./-init-.md)
+
+# <init>
+
+`ClientFollowingAPI(api: `[`SpotifyAPI`](../../com.adamratzman.spotify.main/-spotify-a-p-i/index.md)`)`
+
+These endpoints allow you manage the artists, users and playlists that a Spotify user follows.
+

docs/md/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-following-a-p-i/follow-artist.md

@@ -0,0 +1,11 @@
+[SpotifyKotlinWrapper](../../index.md) / [com.adamratzman.spotify.endpoints.client](../index.md) / [ClientFollowingAPI](index.md) / [followArtist](./follow-artist.md)
+
+# followArtist
+
+`fun followArtist(artistId: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`SpotifyRestAction`](../../com.adamratzman.spotify.main/-spotify-rest-action/index.md)`<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
+
+Add the current user as a follower of an artist
+
+### Exceptions
+
+`BadRequestException` - if an invalid id is provided

docs/md/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-following-a-p-i/follow-artists.md

@@ -0,0 +1,11 @@
+[SpotifyKotlinWrapper](../../index.md) / [com.adamratzman.spotify.endpoints.client](../index.md) / [ClientFollowingAPI](index.md) / [followArtists](./follow-artists.md)
+
+# followArtists
+
+`fun followArtists(vararg artists: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`SpotifyRestAction`](../../com.adamratzman.spotify.main/-spotify-rest-action/index.md)`<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
+
+Add the current user as a follower of other artists
+
+### Exceptions
+
+`BadRequestException` - if an invalid id is provided

docs/md/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-following-a-p-i/follow-playlist.md

@@ -0,0 +1,19 @@
+[SpotifyKotlinWrapper](../../index.md) / [com.adamratzman.spotify.endpoints.client](../index.md) / [ClientFollowingAPI](index.md) / [followPlaylist](./follow-playlist.md)
+
+# followPlaylist
+
+`fun followPlaylist(playlist: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`, followPublicly: `[`Boolean`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html)` = true): `[`SpotifyRestAction`](../../com.adamratzman.spotify.main/-spotify-rest-action/index.md)`<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
+
+Add the current user as a follower of a playlist.
+
+### Parameters
+
+`playlist` - the spotify id or uri of the playlist. Any playlist can be followed, regardless of its
+public/private status, as long as you know its playlist ID.
+
+`followPublicly` - Defaults to true. If true the playlist will be included in user’s public playlists,
+if false it will remain private. To be able to follow playlists privately, the user must have granted the playlist-modify-private scope.
+
+### Exceptions
+
+`BadRequestException` - if the playlist is not found

docs/md/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-following-a-p-i/follow-user.md

@@ -0,0 +1,11 @@
+[SpotifyKotlinWrapper](../../index.md) / [com.adamratzman.spotify.endpoints.client](../index.md) / [ClientFollowingAPI](index.md) / [followUser](./follow-user.md)
+
+# followUser
+
+`fun followUser(user: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`SpotifyRestAction`](../../com.adamratzman.spotify.main/-spotify-rest-action/index.md)`<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
+
+Add the current user as a follower of another user
+
+### Exceptions
+
+`BadRequestException` - if an invalid id is provided

docs/md/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-following-a-p-i/follow-users.md

@@ -0,0 +1,11 @@
+[SpotifyKotlinWrapper](../../index.md) / [com.adamratzman.spotify.endpoints.client](../index.md) / [ClientFollowingAPI](index.md) / [followUsers](./follow-users.md)
+
+# followUsers
+
+`fun followUsers(vararg users: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`): `[`SpotifyRestAction`](../../com.adamratzman.spotify.main/-spotify-rest-action/index.md)`<`[`Unit`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`>`
+
+Add the current user as a follower of other users
+
+### Exceptions
+
+`BadRequestException` - if an invalid id is provided

docs/md/-spotify-kotlin-wrapper/com.adamratzman.spotify.endpoints.client/-client-following-a-p-i/get-followed-artists.md

@@ -0,0 +1,12 @@
+[SpotifyKotlinWrapper](../../index.md) / [com.adamratzman.spotify.endpoints.client](../index.md) / [ClientFollowingAPI](index.md) / [getFollowedArtists](./get-followed-artists.md)
+
+# getFollowedArtists
+
+`fun getFollowedArtists(limit: `[`Int`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html)`? = null, after: `[`String`](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`? = null): `[`SpotifyRestActionPaging`](../../com.adamratzman.spotify.main/-spotify-rest-action-paging/index.md)`<`[`Artist`](../../com.adamratzman.spotify.utils/-artist/index.md)`, `[`CursorBasedPagingObject`](../../com.adamratzman.spotify.utils/-cursor-based-paging-object/index.md)`<`[`Artist`](../../com.adamratzman.spotify.utils/-artist/index.md)`>>`
+
+Get the current user’s followed artists.
+
+**Return**
+[CursorBasedPagingObject](../../com.adamratzman.spotify.utils/-cursor-based-paging-object/index.md) ([Information about them](https://github.com/adamint/spotify-web-api-kotlin/blob/master/README.md#the-benefits-of-linkedresults-pagingobjects-and-cursor-based-paging-objects)
+with full [Artist](../../com.adamratzman.spotify.utils/-artist/index.md) objects
+