Skip to content

Commit c63e0dc

Browse files
committed
update docs
1 parent 8e81830 commit c63e0dc

File tree

60 files changed

+211
-88
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+211
-88
lines changed

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.endpoints.client/-client-following-api/follow-artists.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ <h1>followArtists</h1>
1313
<p>Add the current user as a follower of other artists</p>
1414
<p><strong>Requires</strong> the <a href="../../com.adamratzman.spotify/-spotify-scope/-u-s-e-r_-f-o-l-l-o-w_-m-o-d-i-f-y.html#com.adamratzman.spotify.SpotifyScope.USER_FOLLOW_MODIFY">SpotifyScope.USER_FOLLOW_MODIFY</a> scope</p>
1515
<p><strong><a href="https://developer.spotify.com/documentation/web-api/reference/follow/follow-artists-users/">Api Reference</a></strong></p>
16+
<h3>Parameters</h3>
17+
<p><a name="artists"></a>
18+
<code>artists</code> - User ids or uris. Maximum <strong>50</strong>.</p>
1619
<h3>Exceptions</h3>
1720
<p><a name="BadRequestException"></a>
1821
<code>BadRequestException</code> - if an invalid id is provided</p>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.endpoints.client/-client-following-api/follow-users.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@ <h1>followUsers</h1>
1313
<p>Add the current user as a follower of other users</p>
1414
<p><strong>Requires</strong> the <a href="../../com.adamratzman.spotify/-spotify-scope/-u-s-e-r_-f-o-l-l-o-w_-m-o-d-i-f-y.html#com.adamratzman.spotify.SpotifyScope.USER_FOLLOW_MODIFY">SpotifyScope.USER_FOLLOW_MODIFY</a> scope</p>
1515
<p><strong><a href="https://developer.spotify.com/documentation/web-api/reference/follow/follow-artists-users/">Api Reference</a></strong></p>
16+
<h3>Parameters</h3>
17+
<p><a name="users"></a>
18+
<code>users</code> - User ids or uris. Maximum <strong>50</strong>.</p>
1619
<h3>Exceptions</h3>
1720
<p><a name="BadRequestException"></a>
1821
<code>BadRequestException</code> - if an invalid id is provided</p>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.endpoints.client/-client-following-api/get-followed-artists.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@
99
<br/>
1010
<h1>getFollowedArtists</h1>
1111
<a name="com.adamratzman.spotify.endpoints.client.ClientFollowingApi$getFollowedArtists(kotlin.Int, kotlin.String)"></a>
12-
(common, js, jvm) <code><span class="keyword">fun </span><span class="identifier">getFollowedArtists</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingApi$getFollowedArtists(kotlin.Int, kotlin.String)/limit">limit</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingApi$getFollowedArtists(kotlin.Int, kotlin.String)/after">after</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="../../com.adamratzman.spotify/-spotify-rest-action-paging/index.html"><span class="identifier">SpotifyRestActionPaging</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.models/-artist/index.html"><span class="identifier">Artist</span></a><span class="symbol">,</span>&nbsp;<a href="../../com.adamratzman.spotify.models/-cursor-based-paging-object/index.html"><span class="identifier">CursorBasedPagingObject</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.models/-artist/index.html"><span class="identifier">Artist</span></a><span class="symbol">&gt;</span><span class="symbol">&gt;</span></code>
12+
(common, js, jvm) <code><span class="keyword">fun </span><span class="identifier">getFollowedArtists</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingApi$getFollowedArtists(kotlin.Int, kotlin.String)/limit">limit</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;api.defaultLimit<span class="symbol">, </span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingApi$getFollowedArtists(kotlin.Int, kotlin.String)/after">after</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="../../com.adamratzman.spotify/-spotify-rest-action-paging/index.html"><span class="identifier">SpotifyRestActionPaging</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.models/-artist/index.html"><span class="identifier">Artist</span></a><span class="symbol">,</span>&nbsp;<a href="../../com.adamratzman.spotify.models/-cursor-based-paging-object/index.html"><span class="identifier">CursorBasedPagingObject</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.models/-artist/index.html"><span class="identifier">Artist</span></a><span class="symbol">&gt;</span><span class="symbol">&gt;</span></code>
1313
<p>Get the current user’s followed artists.</p>
1414
<p><strong>Requires</strong> the <a href="../../com.adamratzman.spotify/-spotify-scope/-u-s-e-r_-f-o-l-l-o-w_-r-e-a-d.html#com.adamratzman.spotify.SpotifyScope.USER_FOLLOW_READ">SpotifyScope.USER_FOLLOW_READ</a> scope</p>
1515
<p><strong><a href="https://developer.spotify.com/documentation/web-api/reference/follow/get-followed/">Api Reference</a></strong></p>
1616
<h3>Parameters</h3>
1717
<p><a name="limit"></a>
18-
<code>limit</code> - The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.</p>
18+
<code>limit</code> - The maximum number of items to return. Default: 50 (or api limit). Minimum: 1. Maximum: 50.</p>
1919
<p><a name="after"></a>
2020
<code>after</code> - The last artist ID retrieved from the previous request.</p>
2121
<p><strong>Return</strong><br/>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.endpoints.client/-client-following-api/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ <h4><a href="get-followed-artists.html">getFollowedArtists</a></h4>
8181
</td>
8282
<td>
8383
<p>Get the current user’s followed artists.</p>
84-
<code><span class="keyword">fun </span><span class="identifier">getFollowedArtists</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingApi$getFollowedArtists(kotlin.Int, kotlin.String)/limit">limit</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingApi$getFollowedArtists(kotlin.Int, kotlin.String)/after">after</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="../../com.adamratzman.spotify/-spotify-rest-action-paging/index.html"><span class="identifier">SpotifyRestActionPaging</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.models/-artist/index.html"><span class="identifier">Artist</span></a><span class="symbol">,</span>&nbsp;<a href="../../com.adamratzman.spotify.models/-cursor-based-paging-object/index.html"><span class="identifier">CursorBasedPagingObject</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.models/-artist/index.html"><span class="identifier">Artist</span></a><span class="symbol">&gt;</span><span class="symbol">&gt;</span></code></td>
84+
<code><span class="keyword">fun </span><span class="identifier">getFollowedArtists</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingApi$getFollowedArtists(kotlin.Int, kotlin.String)/limit">limit</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;api.defaultLimit<span class="symbol">, </span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientFollowingApi$getFollowedArtists(kotlin.Int, kotlin.String)/after">after</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html"><span class="identifier">String</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="../../com.adamratzman.spotify/-spotify-rest-action-paging/index.html"><span class="identifier">SpotifyRestActionPaging</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.models/-artist/index.html"><span class="identifier">Artist</span></a><span class="symbol">,</span>&nbsp;<a href="../../com.adamratzman.spotify.models/-cursor-based-paging-object/index.html"><span class="identifier">CursorBasedPagingObject</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.models/-artist/index.html"><span class="identifier">Artist</span></a><span class="symbol">&gt;</span><span class="symbol">&gt;</span></code></td>
8585
</tr>
8686
<tr>
8787
<td>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.endpoints.client/-client-following-api/unfollow-artists.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ <h1>unfollowArtists</h1>
1515
<p><strong><a href="https://developer.spotify.com/documentation/web-api/reference/follow/unfollow-artists-users/">Api Reference</a></strong></p>
1616
<h3>Parameters</h3>
1717
<p><a name="artists"></a>
18-
<code>artists</code> - The artists to be unfollowed from</p>
18+
<code>artists</code> - The artists to be unfollowed from. Maximum <strong>50</strong>.</p>
1919
<h3>Exceptions</h3>
2020
<p><a name="BadRequestException"></a>
2121
<code>BadRequestException</code> - if an invalid id is provided</p>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.endpoints.client/-client-following-api/unfollow-users.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ <h1>unfollowUsers</h1>
1515
<p><strong><a href="https://developer.spotify.com/documentation/web-api/reference/follow/unfollow-artists-users/">Api Reference</a></strong></p>
1616
<h3>Parameters</h3>
1717
<p><a name="users"></a>
18-
<code>users</code> - The users to be unfollowed from</p>
18+
<code>users</code> - The users to be unfollowed from. Maximum <strong>50</strong>.</p>
1919
<h3>Exceptions</h3>
2020
<p><a name="BadRequestException"></a>
2121
<code>BadRequestException</code> - if an invalid id is provided</p>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.endpoints.client/-client-library-api/add.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ <h3>Parameters</h3>
3030
<p><a name="type"></a>
3131
<code>type</code> - The type of objects to check against (album or track)</p>
3232
<p><a name="ids"></a>
33-
<code>ids</code> - The spotify ids or uris of the objects</p>
33+
<code>ids</code> - The spotify ids or uris of the objects. Maximum <strong>50</strong> ids.</p>
3434
<h3>Exceptions</h3>
3535
<p><a name="BadRequestException"></a>
3636
<code>BadRequestException</code> - if any of the provided ids is invalid</p>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.endpoints.client/-client-library-api/contains.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ <h3>Parameters</h3>
3030
<p><a name="type"></a>
3131
<code>type</code> - The type of objects (album or track)</p>
3232
<p><a name="ids"></a>
33-
<code>ids</code> - The spotify ids or uris of the objects</p>
33+
<code>ids</code> - The spotify ids or uris of the objects. Maximum <strong>50</strong> ids.</p>
3434
<h3>Exceptions</h3>
3535
<p><a name="BadRequestException"></a>
3636
<code>BadRequestException</code> - if any of the provided ids is invalid</p>

docs/docs/spotify-web-api-kotlin/com.adamratzman.spotify.endpoints.client/-client-library-api/get-saved-albums.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@
99
<br/>
1010
<h1>getSavedAlbums</h1>
1111
<a name="com.adamratzman.spotify.endpoints.client.ClientLibraryApi$getSavedAlbums(kotlin.Int, kotlin.Int, com.adamratzman.spotify.utils.Market)"></a>
12-
(common, js, jvm) <code><span class="keyword">fun </span><span class="identifier">getSavedAlbums</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientLibraryApi$getSavedAlbums(kotlin.Int, kotlin.Int, com.adamratzman.spotify.utils.Market)/limit">limit</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientLibraryApi$getSavedAlbums(kotlin.Int, kotlin.Int, com.adamratzman.spotify.utils.Market)/offset">offset</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientLibraryApi$getSavedAlbums(kotlin.Int, kotlin.Int, com.adamratzman.spotify.utils.Market)/market">market</span><span class="symbol">:</span>&nbsp;<a href="../../com.adamratzman.spotify.utils/-market/index.html"><span class="identifier">Market</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="../../com.adamratzman.spotify/-spotify-rest-action-paging/index.html"><span class="identifier">SpotifyRestActionPaging</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.models/-saved-album/index.html"><span class="identifier">SavedAlbum</span></a><span class="symbol">,</span>&nbsp;<a href="../../com.adamratzman.spotify.models/-paging-object/index.html"><span class="identifier">PagingObject</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.models/-saved-album/index.html"><span class="identifier">SavedAlbum</span></a><span class="symbol">&gt;</span><span class="symbol">&gt;</span></code>
12+
(common, js, jvm) <code><span class="keyword">fun </span><span class="identifier">getSavedAlbums</span><span class="symbol">(</span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientLibraryApi$getSavedAlbums(kotlin.Int, kotlin.Int, com.adamratzman.spotify.utils.Market)/limit">limit</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;api.defaultLimit<span class="symbol">, </span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientLibraryApi$getSavedAlbums(kotlin.Int, kotlin.Int, com.adamratzman.spotify.utils.Market)/offset">offset</span><span class="symbol">:</span>&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html"><span class="identifier">Int</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">, </span><span class="identifier" id="com.adamratzman.spotify.endpoints.client.ClientLibraryApi$getSavedAlbums(kotlin.Int, kotlin.Int, com.adamratzman.spotify.utils.Market)/market">market</span><span class="symbol">:</span>&nbsp;<a href="../../com.adamratzman.spotify.utils/-market/index.html"><span class="identifier">Market</span></a><span class="symbol">?</span>&nbsp;<span class="symbol">=</span>&nbsp;null<span class="symbol">)</span><span class="symbol">: </span><a href="../../com.adamratzman.spotify/-spotify-rest-action-paging/index.html"><span class="identifier">SpotifyRestActionPaging</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.models/-saved-album/index.html"><span class="identifier">SavedAlbum</span></a><span class="symbol">,</span>&nbsp;<a href="../../com.adamratzman.spotify.models/-paging-object/index.html"><span class="identifier">PagingObject</span></a><span class="symbol">&lt;</span><a href="../../com.adamratzman.spotify.models/-saved-album/index.html"><span class="identifier">SavedAlbum</span></a><span class="symbol">&gt;</span><span class="symbol">&gt;</span></code>
1313
<p>Get a list of the albums saved in the current Spotify user’s ‘Your Music’ library.</p>
1414
<p><strong>Requires</strong> the <a href="../../com.adamratzman.spotify/-spotify-scope/-u-s-e-r_-l-i-b-r-a-r-y_-r-e-a-d.html#com.adamratzman.spotify.SpotifyScope.USER_LIBRARY_READ">SpotifyScope.USER_LIBRARY_READ</a> scope</p>
1515
<p><strong><a href="https://developer.spotify.com/documentation/web-api/reference/library/get-users-saved-albums/">Api Reference</a></strong></p>
1616
<h3>Parameters</h3>
1717
<p><a name="limit"></a>
18-
<code>limit</code> - The number of objects to return. Default: 20. Minimum: 1. Maximum: 50.</p>
18+
<code>limit</code> - The number of objects to return. Default: 50 (or api limit). Minimum: 1. Maximum: 50.</p>
1919
<p><a name="offset"></a>
2020
<code>offset</code> - The index of the first item to return. Default: 0. Use with limit to get the next set of items</p>
2121
<p><a name="market"></a>

0 commit comments

Comments
 (0)