soundcloud-api-ts 1.4.0 → 1.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/{chunk-ALTJSKVN.mjs → chunk-CYDTNVV3.mjs} +2 -2
- package/dist/{chunk-ALTJSKVN.mjs.map → chunk-CYDTNVV3.mjs.map} +1 -1
- package/dist/{chunk-DZRZLIAH.js → chunk-NBKG62HR.js} +2 -2
- package/dist/{chunk-DZRZLIAH.js.map → chunk-NBKG62HR.js.map} +1 -1
- package/dist/index.d.mts +154 -51
- package/dist/index.d.ts +154 -51
- package/dist/index.js +7 -7
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +2 -2
- package/dist/index.mjs.map +1 -1
- package/dist/types/index.d.mts +1 -1
- package/dist/types/index.d.ts +1 -1
- package/dist/types/index.js +2 -2
- package/dist/types/index.mjs +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -58,7 +58,7 @@ interface AutoRefreshContext {
|
|
|
58
58
|
*
|
|
59
59
|
* @example
|
|
60
60
|
* ```ts
|
|
61
|
-
* import { scFetch } from '
|
|
61
|
+
* import { scFetch } from 'soundcloud-api-ts';
|
|
62
62
|
*
|
|
63
63
|
* const track = await scFetch<SoundCloudTrack>({
|
|
64
64
|
* path: '/tracks/123456',
|
|
@@ -83,7 +83,7 @@ declare function scFetch<T>(options: RequestOptions, refreshCtx?: AutoRefreshCon
|
|
|
83
83
|
*
|
|
84
84
|
* @example
|
|
85
85
|
* ```ts
|
|
86
|
-
* import { scFetchUrl } from '
|
|
86
|
+
* import { scFetchUrl } from 'soundcloud-api-ts';
|
|
87
87
|
*
|
|
88
88
|
* const nextPage = await scFetchUrl<SoundCloudPaginatedResponse<SoundCloudTrack>>(
|
|
89
89
|
* response.next_href,
|
|
@@ -143,7 +143,7 @@ interface UpdateTrackParams {
|
|
|
143
143
|
*
|
|
144
144
|
* @example
|
|
145
145
|
* ```ts
|
|
146
|
-
* import { updateTrack } from '
|
|
146
|
+
* import { updateTrack } from 'soundcloud-api-ts';
|
|
147
147
|
*
|
|
148
148
|
* const updated = await updateTrack(token, 123456, {
|
|
149
149
|
* title: 'New Title',
|
|
@@ -203,7 +203,7 @@ interface CreatePlaylistParams {
|
|
|
203
203
|
*
|
|
204
204
|
* @example
|
|
205
205
|
* ```ts
|
|
206
|
-
* import { createPlaylist } from '
|
|
206
|
+
* import { createPlaylist } from 'soundcloud-api-ts';
|
|
207
207
|
*
|
|
208
208
|
* const playlist = await createPlaylist(token, {
|
|
209
209
|
* title: 'My Favorites',
|
|
@@ -265,7 +265,7 @@ interface UpdatePlaylistParams {
|
|
|
265
265
|
*
|
|
266
266
|
* @example
|
|
267
267
|
* ```ts
|
|
268
|
-
* import { updatePlaylist } from '
|
|
268
|
+
* import { updatePlaylist } from 'soundcloud-api-ts';
|
|
269
269
|
*
|
|
270
270
|
* const updated = await updatePlaylist(token, 123456, {
|
|
271
271
|
* title: 'Updated Title',
|
|
@@ -317,7 +317,7 @@ type TokenGetter = () => string | undefined;
|
|
|
317
317
|
*
|
|
318
318
|
* @example
|
|
319
319
|
* ```ts
|
|
320
|
-
* import { SoundCloudClient } from '
|
|
320
|
+
* import { SoundCloudClient } from 'soundcloud-api-ts';
|
|
321
321
|
*
|
|
322
322
|
* const sc = new SoundCloudClient({
|
|
323
323
|
* clientId: 'YOUR_CLIENT_ID',
|
|
@@ -1297,7 +1297,7 @@ declare namespace SoundCloudClient {
|
|
|
1297
1297
|
*
|
|
1298
1298
|
* @example
|
|
1299
1299
|
* ```ts
|
|
1300
|
-
* import { paginate, searchTracks, scFetchUrl } from '
|
|
1300
|
+
* import { paginate, searchTracks, scFetchUrl } from 'soundcloud-api-ts';
|
|
1301
1301
|
*
|
|
1302
1302
|
* const pages = paginate(
|
|
1303
1303
|
* () => searchTracks(token, 'lofi'),
|
|
@@ -1322,7 +1322,7 @@ declare function paginate<T>(firstPage: () => Promise<SoundCloudPaginatedRespons
|
|
|
1322
1322
|
*
|
|
1323
1323
|
* @example
|
|
1324
1324
|
* ```ts
|
|
1325
|
-
* import { paginateItems, searchTracks, scFetchUrl } from '
|
|
1325
|
+
* import { paginateItems, searchTracks, scFetchUrl } from 'soundcloud-api-ts';
|
|
1326
1326
|
*
|
|
1327
1327
|
* const tracks = paginateItems(
|
|
1328
1328
|
* () => searchTracks(token, 'lofi'),
|
|
@@ -1348,7 +1348,7 @@ declare function paginateItems<T>(firstPage: () => Promise<SoundCloudPaginatedRe
|
|
|
1348
1348
|
*
|
|
1349
1349
|
* @example
|
|
1350
1350
|
* ```ts
|
|
1351
|
-
* import { fetchAll, searchTracks, scFetchUrl } from '
|
|
1351
|
+
* import { fetchAll, searchTracks, scFetchUrl } from 'soundcloud-api-ts';
|
|
1352
1352
|
*
|
|
1353
1353
|
* const allTracks = await fetchAll(
|
|
1354
1354
|
* () => searchTracks(token, 'lofi'),
|
|
@@ -1376,7 +1376,7 @@ declare function fetchAll<T>(firstPage: () => Promise<SoundCloudPaginatedRespons
|
|
|
1376
1376
|
*
|
|
1377
1377
|
* @example
|
|
1378
1378
|
* ```ts
|
|
1379
|
-
* import { getClientToken } from '
|
|
1379
|
+
* import { getClientToken } from 'soundcloud-api-ts';
|
|
1380
1380
|
*
|
|
1381
1381
|
* const token = await getClientToken('YOUR_CLIENT_ID', 'YOUR_CLIENT_SECRET');
|
|
1382
1382
|
* console.log(token.access_token);
|
|
@@ -1401,7 +1401,7 @@ declare const getClientToken: (clientId: string, clientSecret: string) => Promis
|
|
|
1401
1401
|
*
|
|
1402
1402
|
* @example
|
|
1403
1403
|
* ```ts
|
|
1404
|
-
* import { getUserToken } from '
|
|
1404
|
+
* import { getUserToken } from 'soundcloud-api-ts';
|
|
1405
1405
|
*
|
|
1406
1406
|
* const token = await getUserToken(
|
|
1407
1407
|
* 'YOUR_CLIENT_ID',
|
|
@@ -1431,7 +1431,7 @@ declare const getUserToken: (clientId: string, clientSecret: string, redirectUri
|
|
|
1431
1431
|
*
|
|
1432
1432
|
* @example
|
|
1433
1433
|
* ```ts
|
|
1434
|
-
* import { refreshUserToken } from '
|
|
1434
|
+
* import { refreshUserToken } from 'soundcloud-api-ts';
|
|
1435
1435
|
*
|
|
1436
1436
|
* const newToken = await refreshUserToken(
|
|
1437
1437
|
* 'YOUR_CLIENT_ID',
|
|
@@ -1457,7 +1457,7 @@ declare const refreshUserToken: (clientId: string, clientSecret: string, redirec
|
|
|
1457
1457
|
*
|
|
1458
1458
|
* @example
|
|
1459
1459
|
* ```ts
|
|
1460
|
-
* import { signOut } from '
|
|
1460
|
+
* import { signOut } from 'soundcloud-api-ts';
|
|
1461
1461
|
*
|
|
1462
1462
|
* await signOut('your-access-token');
|
|
1463
1463
|
* ```
|
|
@@ -1478,7 +1478,7 @@ declare const signOut: (accessToken: string) => Promise<void>;
|
|
|
1478
1478
|
*
|
|
1479
1479
|
* @example
|
|
1480
1480
|
* ```ts
|
|
1481
|
-
* import { getAuthorizationUrl, generateCodeVerifier, generateCodeChallenge } from '
|
|
1481
|
+
* import { getAuthorizationUrl, generateCodeVerifier, generateCodeChallenge } from 'soundcloud-api-ts';
|
|
1482
1482
|
*
|
|
1483
1483
|
* const verifier = generateCodeVerifier();
|
|
1484
1484
|
* const challenge = await generateCodeChallenge(verifier);
|
|
@@ -1505,7 +1505,7 @@ declare function getAuthorizationUrl(clientId: string, redirectUri: string, opti
|
|
|
1505
1505
|
*
|
|
1506
1506
|
* @example
|
|
1507
1507
|
* ```ts
|
|
1508
|
-
* import { generateCodeVerifier, generateCodeChallenge } from '
|
|
1508
|
+
* import { generateCodeVerifier, generateCodeChallenge } from 'soundcloud-api-ts';
|
|
1509
1509
|
*
|
|
1510
1510
|
* const verifier = generateCodeVerifier();
|
|
1511
1511
|
* const challenge = await generateCodeChallenge(verifier);
|
|
@@ -1526,7 +1526,7 @@ declare function generateCodeVerifier(): string;
|
|
|
1526
1526
|
*
|
|
1527
1527
|
* @example
|
|
1528
1528
|
* ```ts
|
|
1529
|
-
* import { generateCodeVerifier, generateCodeChallenge } from '
|
|
1529
|
+
* import { generateCodeVerifier, generateCodeChallenge } from 'soundcloud-api-ts';
|
|
1530
1530
|
*
|
|
1531
1531
|
* const verifier = generateCodeVerifier();
|
|
1532
1532
|
* const challenge = await generateCodeChallenge(verifier);
|
|
@@ -1546,7 +1546,7 @@ declare function generateCodeChallenge(verifier: string): Promise<string>;
|
|
|
1546
1546
|
*
|
|
1547
1547
|
* @example
|
|
1548
1548
|
* ```ts
|
|
1549
|
-
* import { getMe } from '
|
|
1549
|
+
* import { getMe } from 'soundcloud-api-ts';
|
|
1550
1550
|
*
|
|
1551
1551
|
* const me = await getMe(token);
|
|
1552
1552
|
* console.log(me.username, me.private_tracks_count);
|
|
@@ -1566,7 +1566,7 @@ declare const getMe: (token: string) => Promise<SoundCloudMe>;
|
|
|
1566
1566
|
*
|
|
1567
1567
|
* @example
|
|
1568
1568
|
* ```ts
|
|
1569
|
-
* import { getUser } from '
|
|
1569
|
+
* import { getUser } from 'soundcloud-api-ts';
|
|
1570
1570
|
*
|
|
1571
1571
|
* const user = await getUser(token, 123456);
|
|
1572
1572
|
* console.log(user.username);
|
|
@@ -1587,7 +1587,7 @@ declare const getUser: (token: string, userId: string | number) => Promise<Sound
|
|
|
1587
1587
|
*
|
|
1588
1588
|
* @example
|
|
1589
1589
|
* ```ts
|
|
1590
|
-
* import { getFollowers } from '
|
|
1590
|
+
* import { getFollowers } from 'soundcloud-api-ts';
|
|
1591
1591
|
*
|
|
1592
1592
|
* const result = await getFollowers(token, 123456, 50);
|
|
1593
1593
|
* result.collection.forEach(u => console.log(u.username));
|
|
@@ -1608,7 +1608,7 @@ declare const getFollowers: (token: string, userId: string | number, limit?: num
|
|
|
1608
1608
|
*
|
|
1609
1609
|
* @example
|
|
1610
1610
|
* ```ts
|
|
1611
|
-
* import { getFollowings } from '
|
|
1611
|
+
* import { getFollowings } from 'soundcloud-api-ts';
|
|
1612
1612
|
*
|
|
1613
1613
|
* const result = await getFollowings(token, 123456, 50);
|
|
1614
1614
|
* result.collection.forEach(u => console.log(u.username));
|
|
@@ -1629,7 +1629,7 @@ declare const getFollowings: (token: string, userId: string | number, limit?: nu
|
|
|
1629
1629
|
*
|
|
1630
1630
|
* @example
|
|
1631
1631
|
* ```ts
|
|
1632
|
-
* import { getUserTracks } from '
|
|
1632
|
+
* import { getUserTracks } from 'soundcloud-api-ts';
|
|
1633
1633
|
*
|
|
1634
1634
|
* const result = await getUserTracks(token, 123456, 25);
|
|
1635
1635
|
* result.collection.forEach(t => console.log(t.title));
|
|
@@ -1650,7 +1650,7 @@ declare const getUserTracks: (token: string, userId: string | number, limit?: nu
|
|
|
1650
1650
|
*
|
|
1651
1651
|
* @example
|
|
1652
1652
|
* ```ts
|
|
1653
|
-
* import { getUserPlaylists } from '
|
|
1653
|
+
* import { getUserPlaylists } from 'soundcloud-api-ts';
|
|
1654
1654
|
*
|
|
1655
1655
|
* const result = await getUserPlaylists(token, 123456, 10);
|
|
1656
1656
|
* result.collection.forEach(p => console.log(p.title));
|
|
@@ -1672,7 +1672,7 @@ declare const getUserPlaylists: (token: string, userId: string | number, limit?:
|
|
|
1672
1672
|
*
|
|
1673
1673
|
* @example
|
|
1674
1674
|
* ```ts
|
|
1675
|
-
* import { getUserLikesTracks } from '
|
|
1675
|
+
* import { getUserLikesTracks } from 'soundcloud-api-ts';
|
|
1676
1676
|
*
|
|
1677
1677
|
* const result = await getUserLikesTracks(token, 123456, 50);
|
|
1678
1678
|
* result.collection.forEach(t => console.log(t.title));
|
|
@@ -1693,7 +1693,7 @@ declare const getUserLikesTracks: (token: string, userId: string | number, limit
|
|
|
1693
1693
|
*
|
|
1694
1694
|
* @example
|
|
1695
1695
|
* ```ts
|
|
1696
|
-
* import { getUserLikesPlaylists } from '
|
|
1696
|
+
* import { getUserLikesPlaylists } from 'soundcloud-api-ts';
|
|
1697
1697
|
*
|
|
1698
1698
|
* const result = await getUserLikesPlaylists(token, 123456, 10);
|
|
1699
1699
|
* result.collection.forEach(p => console.log(p.title));
|
|
@@ -1713,7 +1713,7 @@ declare const getUserLikesPlaylists: (token: string, userId: string | number, li
|
|
|
1713
1713
|
*
|
|
1714
1714
|
* @example
|
|
1715
1715
|
* ```ts
|
|
1716
|
-
* import { getUserWebProfiles } from '
|
|
1716
|
+
* import { getUserWebProfiles } from 'soundcloud-api-ts';
|
|
1717
1717
|
*
|
|
1718
1718
|
* const profiles = await getUserWebProfiles(token, 123456);
|
|
1719
1719
|
* profiles.forEach(p => console.log(p.service, p.url));
|
|
@@ -1733,7 +1733,7 @@ declare const getUserWebProfiles: (token: string, userId: string | number) => Pr
|
|
|
1733
1733
|
*
|
|
1734
1734
|
* @example
|
|
1735
1735
|
* ```ts
|
|
1736
|
-
* import { getTrack } from '
|
|
1736
|
+
* import { getTrack } from 'soundcloud-api-ts';
|
|
1737
1737
|
*
|
|
1738
1738
|
* const track = await getTrack(token, 123456);
|
|
1739
1739
|
* console.log(track.title, track.duration);
|
|
@@ -1754,7 +1754,7 @@ declare const getTrack: (token: string, trackId: string | number) => Promise<Sou
|
|
|
1754
1754
|
*
|
|
1755
1755
|
* @example
|
|
1756
1756
|
* ```ts
|
|
1757
|
-
* import { getTrackComments } from '
|
|
1757
|
+
* import { getTrackComments } from 'soundcloud-api-ts';
|
|
1758
1758
|
*
|
|
1759
1759
|
* const result = await getTrackComments(token, 123456, 20);
|
|
1760
1760
|
* result.collection.forEach(c => console.log(c.body));
|
|
@@ -1776,7 +1776,7 @@ declare const getTrackComments: (token: string, trackId: string | number, limit?
|
|
|
1776
1776
|
*
|
|
1777
1777
|
* @example
|
|
1778
1778
|
* ```ts
|
|
1779
|
-
* import { createTrackComment } from '
|
|
1779
|
+
* import { createTrackComment } from 'soundcloud-api-ts';
|
|
1780
1780
|
*
|
|
1781
1781
|
* const comment = await createTrackComment(token, 123456, 'Great drop!', 60000);
|
|
1782
1782
|
* console.log(comment.id);
|
|
@@ -1797,7 +1797,7 @@ declare const createTrackComment: (token: string, trackId: string | number, body
|
|
|
1797
1797
|
*
|
|
1798
1798
|
* @example
|
|
1799
1799
|
* ```ts
|
|
1800
|
-
* import { getTrackLikes } from '
|
|
1800
|
+
* import { getTrackLikes } from 'soundcloud-api-ts';
|
|
1801
1801
|
*
|
|
1802
1802
|
* const result = await getTrackLikes(token, 123456, 50);
|
|
1803
1803
|
* result.collection.forEach(u => console.log(u.username));
|
|
@@ -1818,7 +1818,7 @@ declare const getTrackLikes: (token: string, trackId: string | number, limit?: n
|
|
|
1818
1818
|
*
|
|
1819
1819
|
* @example
|
|
1820
1820
|
* ```ts
|
|
1821
|
-
* import { getTrackReposts } from '
|
|
1821
|
+
* import { getTrackReposts } from 'soundcloud-api-ts';
|
|
1822
1822
|
*
|
|
1823
1823
|
* const result = await getTrackReposts(token, 123456, 50);
|
|
1824
1824
|
* result.collection.forEach(u => console.log(u.username));
|
|
@@ -1839,7 +1839,7 @@ declare const getTrackReposts: (token: string, trackId: string | number, limit?:
|
|
|
1839
1839
|
*
|
|
1840
1840
|
* @example
|
|
1841
1841
|
* ```ts
|
|
1842
|
-
* import { getRelatedTracks } from '
|
|
1842
|
+
* import { getRelatedTracks } from 'soundcloud-api-ts';
|
|
1843
1843
|
*
|
|
1844
1844
|
* const related = await getRelatedTracks(token, 123456, 5);
|
|
1845
1845
|
* related.forEach(t => console.log(t.title));
|
|
@@ -1859,7 +1859,7 @@ declare const getRelatedTracks: (token: string, trackId: string | number, limit?
|
|
|
1859
1859
|
*
|
|
1860
1860
|
* @example
|
|
1861
1861
|
* ```ts
|
|
1862
|
-
* import { getTrackStreams } from '
|
|
1862
|
+
* import { getTrackStreams } from 'soundcloud-api-ts';
|
|
1863
1863
|
*
|
|
1864
1864
|
* const streams = await getTrackStreams(token, 123456);
|
|
1865
1865
|
* console.log(streams.hls_mp3_128_url);
|
|
@@ -1878,7 +1878,7 @@ declare const getTrackStreams: (token: string, trackId: string | number) => Prom
|
|
|
1878
1878
|
*
|
|
1879
1879
|
* @example
|
|
1880
1880
|
* ```ts
|
|
1881
|
-
* import { likeTrack } from '
|
|
1881
|
+
* import { likeTrack } from 'soundcloud-api-ts';
|
|
1882
1882
|
*
|
|
1883
1883
|
* const success = await likeTrack(token, 123456);
|
|
1884
1884
|
* ```
|
|
@@ -1896,7 +1896,7 @@ declare const likeTrack: (token: string, trackId: string | number) => Promise<bo
|
|
|
1896
1896
|
*
|
|
1897
1897
|
* @example
|
|
1898
1898
|
* ```ts
|
|
1899
|
-
* import { unlikeTrack } from '
|
|
1899
|
+
* import { unlikeTrack } from 'soundcloud-api-ts';
|
|
1900
1900
|
*
|
|
1901
1901
|
* const success = await unlikeTrack(token, 123456);
|
|
1902
1902
|
* ```
|
|
@@ -1914,7 +1914,7 @@ declare const unlikeTrack: (token: string, trackId: string | number) => Promise<
|
|
|
1914
1914
|
*
|
|
1915
1915
|
* @example
|
|
1916
1916
|
* ```ts
|
|
1917
|
-
* import { deleteTrack } from '
|
|
1917
|
+
* import { deleteTrack } from 'soundcloud-api-ts';
|
|
1918
1918
|
*
|
|
1919
1919
|
* await deleteTrack(token, 123456);
|
|
1920
1920
|
* ```
|
|
@@ -1933,7 +1933,7 @@ declare const deleteTrack: (token: string, trackId: string | number) => Promise<
|
|
|
1933
1933
|
*
|
|
1934
1934
|
* @example
|
|
1935
1935
|
* ```ts
|
|
1936
|
-
* import { getPlaylist } from '
|
|
1936
|
+
* import { getPlaylist } from 'soundcloud-api-ts';
|
|
1937
1937
|
*
|
|
1938
1938
|
* const playlist = await getPlaylist(token, 123456);
|
|
1939
1939
|
* console.log(playlist.title, playlist.track_count);
|
|
@@ -1955,7 +1955,7 @@ declare const getPlaylist: (token: string, playlistId: string | number) => Promi
|
|
|
1955
1955
|
*
|
|
1956
1956
|
* @example
|
|
1957
1957
|
* ```ts
|
|
1958
|
-
* import { getPlaylistTracks } from '
|
|
1958
|
+
* import { getPlaylistTracks } from 'soundcloud-api-ts';
|
|
1959
1959
|
*
|
|
1960
1960
|
* const result = await getPlaylistTracks(token, 123456, 25);
|
|
1961
1961
|
* result.collection.forEach(t => console.log(t.title));
|
|
@@ -1976,7 +1976,7 @@ declare const getPlaylistTracks: (token: string, playlistId: string | number, li
|
|
|
1976
1976
|
*
|
|
1977
1977
|
* @example
|
|
1978
1978
|
* ```ts
|
|
1979
|
-
* import { getPlaylistReposts } from '
|
|
1979
|
+
* import { getPlaylistReposts } from 'soundcloud-api-ts';
|
|
1980
1980
|
*
|
|
1981
1981
|
* const result = await getPlaylistReposts(token, 123456, 50);
|
|
1982
1982
|
* result.collection.forEach(u => console.log(u.username));
|
|
@@ -1995,7 +1995,7 @@ declare const getPlaylistReposts: (token: string, playlistId: string | number, l
|
|
|
1995
1995
|
*
|
|
1996
1996
|
* @example
|
|
1997
1997
|
* ```ts
|
|
1998
|
-
* import { deletePlaylist } from '
|
|
1998
|
+
* import { deletePlaylist } from 'soundcloud-api-ts';
|
|
1999
1999
|
*
|
|
2000
2000
|
* await deletePlaylist(token, 123456);
|
|
2001
2001
|
* ```
|
|
@@ -2015,7 +2015,7 @@ declare const deletePlaylist: (token: string, playlistId: string | number) => Pr
|
|
|
2015
2015
|
*
|
|
2016
2016
|
* @example
|
|
2017
2017
|
* ```ts
|
|
2018
|
-
* import { searchTracks } from '
|
|
2018
|
+
* import { searchTracks } from 'soundcloud-api-ts';
|
|
2019
2019
|
*
|
|
2020
2020
|
* const result = await searchTracks(token, 'lofi hip hop');
|
|
2021
2021
|
* result.collection.forEach(t => console.log(t.title));
|
|
@@ -2036,7 +2036,7 @@ declare const searchTracks: (token: string, query: string, pageNumber?: number)
|
|
|
2036
2036
|
*
|
|
2037
2037
|
* @example
|
|
2038
2038
|
* ```ts
|
|
2039
|
-
* import { searchUsers } from '
|
|
2039
|
+
* import { searchUsers } from 'soundcloud-api-ts';
|
|
2040
2040
|
*
|
|
2041
2041
|
* const result = await searchUsers(token, 'deadmau5');
|
|
2042
2042
|
* result.collection.forEach(u => console.log(u.username));
|
|
@@ -2057,7 +2057,7 @@ declare const searchUsers: (token: string, query: string, pageNumber?: number) =
|
|
|
2057
2057
|
*
|
|
2058
2058
|
* @example
|
|
2059
2059
|
* ```ts
|
|
2060
|
-
* import { searchPlaylists } from '
|
|
2060
|
+
* import { searchPlaylists } from 'soundcloud-api-ts';
|
|
2061
2061
|
*
|
|
2062
2062
|
* const result = await searchPlaylists(token, 'chill vibes');
|
|
2063
2063
|
* result.collection.forEach(p => console.log(p.title));
|
|
@@ -2079,7 +2079,7 @@ declare const searchPlaylists: (token: string, query: string, pageNumber?: numbe
|
|
|
2079
2079
|
*
|
|
2080
2080
|
* @example
|
|
2081
2081
|
* ```ts
|
|
2082
|
-
* import { resolveUrl } from '
|
|
2082
|
+
* import { resolveUrl } from 'soundcloud-api-ts';
|
|
2083
2083
|
*
|
|
2084
2084
|
* const apiUrl = await resolveUrl(token, 'https://soundcloud.com/deadmau5/strobe');
|
|
2085
2085
|
* console.log(apiUrl); // "https://api.soundcloud.com/tracks/..."
|
|
@@ -2099,7 +2099,7 @@ declare const resolveUrl: (token: string, url: string) => Promise<string>;
|
|
|
2099
2099
|
*
|
|
2100
2100
|
* @example
|
|
2101
2101
|
* ```ts
|
|
2102
|
-
* import { getMeActivities } from '
|
|
2102
|
+
* import { getMeActivities } from 'soundcloud-api-ts';
|
|
2103
2103
|
*
|
|
2104
2104
|
* const activities = await getMeActivities(token, 25);
|
|
2105
2105
|
* activities.collection.forEach(a => console.log(a.type));
|
|
@@ -2116,6 +2116,14 @@ declare const getMeActivities: (token: string, limit?: number) => Promise<SoundC
|
|
|
2116
2116
|
* @returns Activities response
|
|
2117
2117
|
* @throws {SoundCloudError} When the API returns an error
|
|
2118
2118
|
*
|
|
2119
|
+
* @example
|
|
2120
|
+
* ```ts
|
|
2121
|
+
* import { getMeActivitiesOwn } from 'soundcloud-api-ts';
|
|
2122
|
+
*
|
|
2123
|
+
* const activities = await getMeActivitiesOwn(token, 25);
|
|
2124
|
+
* activities.collection.forEach(a => console.log(a.type));
|
|
2125
|
+
* ```
|
|
2126
|
+
*
|
|
2119
2127
|
* @see https://developers.soundcloud.com/docs/api/explorer/open-api#/me/get_me_activities_all_own
|
|
2120
2128
|
*/
|
|
2121
2129
|
declare const getMeActivitiesOwn: (token: string, limit?: number) => Promise<SoundCloudActivitiesResponse>;
|
|
@@ -2127,6 +2135,14 @@ declare const getMeActivitiesOwn: (token: string, limit?: number) => Promise<Sou
|
|
|
2127
2135
|
* @returns Activities response filtered to track activities
|
|
2128
2136
|
* @throws {SoundCloudError} When the API returns an error
|
|
2129
2137
|
*
|
|
2138
|
+
* @example
|
|
2139
|
+
* ```ts
|
|
2140
|
+
* import { getMeActivitiesTracks } from 'soundcloud-api-ts';
|
|
2141
|
+
*
|
|
2142
|
+
* const activities = await getMeActivitiesTracks(token, 25);
|
|
2143
|
+
* activities.collection.forEach(a => console.log(a.type));
|
|
2144
|
+
* ```
|
|
2145
|
+
*
|
|
2130
2146
|
* @see https://developers.soundcloud.com/docs/api/explorer/open-api#/me/get_me_activities_tracks
|
|
2131
2147
|
*/
|
|
2132
2148
|
declare const getMeActivitiesTracks: (token: string, limit?: number) => Promise<SoundCloudActivitiesResponse>;
|
|
@@ -2141,7 +2157,7 @@ declare const getMeActivitiesTracks: (token: string, limit?: number) => Promise<
|
|
|
2141
2157
|
*
|
|
2142
2158
|
* @example
|
|
2143
2159
|
* ```ts
|
|
2144
|
-
* import { getMeLikesTracks } from '
|
|
2160
|
+
* import { getMeLikesTracks } from 'soundcloud-api-ts';
|
|
2145
2161
|
*
|
|
2146
2162
|
* const result = await getMeLikesTracks(token, 50);
|
|
2147
2163
|
* result.collection.forEach(t => console.log(t.title));
|
|
@@ -2158,6 +2174,14 @@ declare const getMeLikesTracks: (token: string, limit?: number) => Promise<Sound
|
|
|
2158
2174
|
* @returns Paginated list of liked playlists
|
|
2159
2175
|
* @throws {SoundCloudError} When the API returns an error
|
|
2160
2176
|
*
|
|
2177
|
+
* @example
|
|
2178
|
+
* ```ts
|
|
2179
|
+
* import { getMeLikesPlaylists } from 'soundcloud-api-ts';
|
|
2180
|
+
*
|
|
2181
|
+
* const result = await getMeLikesPlaylists(token, 50);
|
|
2182
|
+
* result.collection.forEach(p => console.log(p.title));
|
|
2183
|
+
* ```
|
|
2184
|
+
*
|
|
2161
2185
|
* @see https://developers.soundcloud.com/docs/api/explorer/open-api#/me/get_me_likes_playlists
|
|
2162
2186
|
*/
|
|
2163
2187
|
declare const getMeLikesPlaylists: (token: string, limit?: number) => Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>;
|
|
@@ -2170,6 +2194,14 @@ declare const getMeLikesPlaylists: (token: string, limit?: number) => Promise<So
|
|
|
2170
2194
|
* @returns Paginated list of followed users
|
|
2171
2195
|
* @throws {SoundCloudError} When the API returns an error
|
|
2172
2196
|
*
|
|
2197
|
+
* @example
|
|
2198
|
+
* ```ts
|
|
2199
|
+
* import { getMeFollowings } from 'soundcloud-api-ts';
|
|
2200
|
+
*
|
|
2201
|
+
* const result = await getMeFollowings(token, 50);
|
|
2202
|
+
* result.collection.forEach(u => console.log(u.username));
|
|
2203
|
+
* ```
|
|
2204
|
+
*
|
|
2173
2205
|
* @see https://developers.soundcloud.com/docs/api/explorer/open-api#/me/get_me_followings
|
|
2174
2206
|
*/
|
|
2175
2207
|
declare const getMeFollowings: (token: string, limit?: number) => Promise<SoundCloudPaginatedResponse<SoundCloudUser>>;
|
|
@@ -2181,6 +2213,14 @@ declare const getMeFollowings: (token: string, limit?: number) => Promise<SoundC
|
|
|
2181
2213
|
* @returns Paginated list of tracks from followed users
|
|
2182
2214
|
* @throws {SoundCloudError} When the API returns an error
|
|
2183
2215
|
*
|
|
2216
|
+
* @example
|
|
2217
|
+
* ```ts
|
|
2218
|
+
* import { getMeFollowingsTracks } from 'soundcloud-api-ts';
|
|
2219
|
+
*
|
|
2220
|
+
* const result = await getMeFollowingsTracks(token, 50);
|
|
2221
|
+
* result.collection.forEach(t => console.log(t.title));
|
|
2222
|
+
* ```
|
|
2223
|
+
*
|
|
2184
2224
|
* @see https://developers.soundcloud.com/docs/api/explorer/open-api#/me/get_me_followings_tracks
|
|
2185
2225
|
*/
|
|
2186
2226
|
declare const getMeFollowingsTracks: (token: string, limit?: number) => Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>;
|
|
@@ -2193,7 +2233,7 @@ declare const getMeFollowingsTracks: (token: string, limit?: number) => Promise<
|
|
|
2193
2233
|
*
|
|
2194
2234
|
* @example
|
|
2195
2235
|
* ```ts
|
|
2196
|
-
* import { followUser } from '
|
|
2236
|
+
* import { followUser } from 'soundcloud-api-ts';
|
|
2197
2237
|
*
|
|
2198
2238
|
* await followUser(token, 123456);
|
|
2199
2239
|
* ```
|
|
@@ -2210,7 +2250,7 @@ declare const followUser: (token: string, userUrn: string | number) => Promise<v
|
|
|
2210
2250
|
*
|
|
2211
2251
|
* @example
|
|
2212
2252
|
* ```ts
|
|
2213
|
-
* import { unfollowUser } from '
|
|
2253
|
+
* import { unfollowUser } from 'soundcloud-api-ts';
|
|
2214
2254
|
*
|
|
2215
2255
|
* await unfollowUser(token, 123456);
|
|
2216
2256
|
* ```
|
|
@@ -2229,7 +2269,7 @@ declare const unfollowUser: (token: string, userUrn: string | number) => Promise
|
|
|
2229
2269
|
*
|
|
2230
2270
|
* @example
|
|
2231
2271
|
* ```ts
|
|
2232
|
-
* import { getMeFollowers } from '
|
|
2272
|
+
* import { getMeFollowers } from 'soundcloud-api-ts';
|
|
2233
2273
|
*
|
|
2234
2274
|
* const result = await getMeFollowers(token, 50);
|
|
2235
2275
|
* result.collection.forEach(u => console.log(u.username));
|
|
@@ -2249,7 +2289,7 @@ declare const getMeFollowers: (token: string, limit?: number) => Promise<SoundCl
|
|
|
2249
2289
|
*
|
|
2250
2290
|
* @example
|
|
2251
2291
|
* ```ts
|
|
2252
|
-
* import { getMePlaylists } from '
|
|
2292
|
+
* import { getMePlaylists } from 'soundcloud-api-ts';
|
|
2253
2293
|
*
|
|
2254
2294
|
* const result = await getMePlaylists(token, 10);
|
|
2255
2295
|
* result.collection.forEach(p => console.log(p.title));
|
|
@@ -2259,7 +2299,24 @@ declare const getMeFollowers: (token: string, limit?: number) => Promise<SoundCl
|
|
|
2259
2299
|
*/
|
|
2260
2300
|
declare const getMePlaylists: (token: string, limit?: number) => Promise<SoundCloudPaginatedResponse<SoundCloudPlaylist>>;
|
|
2261
2301
|
|
|
2262
|
-
/**
|
|
2302
|
+
/**
|
|
2303
|
+
* Fetch tracks uploaded by the authenticated user.
|
|
2304
|
+
*
|
|
2305
|
+
* @param token - OAuth access token
|
|
2306
|
+
* @param limit - Maximum number of tracks per page
|
|
2307
|
+
* @returns Paginated list of the user's tracks
|
|
2308
|
+
* @throws {SoundCloudError} When the API returns an error
|
|
2309
|
+
*
|
|
2310
|
+
* @example
|
|
2311
|
+
* ```ts
|
|
2312
|
+
* import { getMeTracks } from 'soundcloud-api-ts';
|
|
2313
|
+
*
|
|
2314
|
+
* const result = await getMeTracks(token, 50);
|
|
2315
|
+
* result.collection.forEach(t => console.log(t.title));
|
|
2316
|
+
* ```
|
|
2317
|
+
*
|
|
2318
|
+
* @see https://developers.soundcloud.com/docs/api/explorer/open-api#/me/get_me_tracks
|
|
2319
|
+
*/
|
|
2263
2320
|
declare const getMeTracks: (token: string, limit?: number) => Promise<SoundCloudPaginatedResponse<SoundCloudTrack>>;
|
|
2264
2321
|
|
|
2265
2322
|
/**
|
|
@@ -2269,6 +2326,13 @@ declare const getMeTracks: (token: string, limit?: number) => Promise<SoundCloud
|
|
|
2269
2326
|
* @param playlistId - The playlist's numeric ID or URN
|
|
2270
2327
|
* @returns `true` if the like was successful, `false` on failure
|
|
2271
2328
|
*
|
|
2329
|
+
* @example
|
|
2330
|
+
* ```ts
|
|
2331
|
+
* import { likePlaylist } from 'soundcloud-api-ts';
|
|
2332
|
+
*
|
|
2333
|
+
* const success = await likePlaylist(token, 789012);
|
|
2334
|
+
* ```
|
|
2335
|
+
*
|
|
2272
2336
|
* @see https://developers.soundcloud.com/docs/api/explorer/open-api#/likes/post_likes_playlists__playlist_id_
|
|
2273
2337
|
*/
|
|
2274
2338
|
declare const likePlaylist: (token: string, playlistId: string | number) => Promise<boolean>;
|
|
@@ -2279,6 +2343,13 @@ declare const likePlaylist: (token: string, playlistId: string | number) => Prom
|
|
|
2279
2343
|
* @param playlistId - The playlist's numeric ID or URN
|
|
2280
2344
|
* @returns `true` if the unlike was successful, `false` on failure
|
|
2281
2345
|
*
|
|
2346
|
+
* @example
|
|
2347
|
+
* ```ts
|
|
2348
|
+
* import { unlikePlaylist } from 'soundcloud-api-ts';
|
|
2349
|
+
*
|
|
2350
|
+
* const success = await unlikePlaylist(token, 789012);
|
|
2351
|
+
* ```
|
|
2352
|
+
*
|
|
2282
2353
|
* @see https://developers.soundcloud.com/docs/api/explorer/open-api#/likes/delete_likes_playlists__playlist_id_
|
|
2283
2354
|
*/
|
|
2284
2355
|
declare const unlikePlaylist: (token: string, playlistId: string | number) => Promise<boolean>;
|
|
@@ -2292,7 +2363,7 @@ declare const unlikePlaylist: (token: string, playlistId: string | number) => Pr
|
|
|
2292
2363
|
*
|
|
2293
2364
|
* @example
|
|
2294
2365
|
* ```ts
|
|
2295
|
-
* import { repostTrack } from '
|
|
2366
|
+
* import { repostTrack } from 'soundcloud-api-ts';
|
|
2296
2367
|
*
|
|
2297
2368
|
* const success = await repostTrack(token, 123456);
|
|
2298
2369
|
* ```
|
|
@@ -2307,6 +2378,13 @@ declare const repostTrack: (token: string, trackId: string | number) => Promise<
|
|
|
2307
2378
|
* @param trackId - The track's numeric ID or URN
|
|
2308
2379
|
* @returns `true` if the unrepost was successful, `false` on failure
|
|
2309
2380
|
*
|
|
2381
|
+
* @example
|
|
2382
|
+
* ```ts
|
|
2383
|
+
* import { unrepostTrack } from 'soundcloud-api-ts';
|
|
2384
|
+
*
|
|
2385
|
+
* const success = await unrepostTrack(token, 123456);
|
|
2386
|
+
* ```
|
|
2387
|
+
*
|
|
2310
2388
|
* @see https://developers.soundcloud.com/docs/api/explorer/open-api#/reposts/delete_reposts_tracks__track_id_
|
|
2311
2389
|
*/
|
|
2312
2390
|
declare const unrepostTrack: (token: string, trackId: string | number) => Promise<boolean>;
|
|
@@ -2317,6 +2395,13 @@ declare const unrepostTrack: (token: string, trackId: string | number) => Promis
|
|
|
2317
2395
|
* @param playlistId - The playlist's numeric ID or URN
|
|
2318
2396
|
* @returns `true` if the repost was successful, `false` on failure
|
|
2319
2397
|
*
|
|
2398
|
+
* @example
|
|
2399
|
+
* ```ts
|
|
2400
|
+
* import { repostPlaylist } from 'soundcloud-api-ts';
|
|
2401
|
+
*
|
|
2402
|
+
* const success = await repostPlaylist(token, 789012);
|
|
2403
|
+
* ```
|
|
2404
|
+
*
|
|
2320
2405
|
* @see https://developers.soundcloud.com/docs/api/explorer/open-api#/reposts/post_reposts_playlists__playlist_id_
|
|
2321
2406
|
*/
|
|
2322
2407
|
declare const repostPlaylist: (token: string, playlistId: string | number) => Promise<boolean>;
|
|
@@ -2327,12 +2412,30 @@ declare const repostPlaylist: (token: string, playlistId: string | number) => Pr
|
|
|
2327
2412
|
* @param playlistId - The playlist's numeric ID or URN
|
|
2328
2413
|
* @returns `true` if the unrepost was successful, `false` on failure
|
|
2329
2414
|
*
|
|
2415
|
+
* @example
|
|
2416
|
+
* ```ts
|
|
2417
|
+
* import { unrepostPlaylist } from 'soundcloud-api-ts';
|
|
2418
|
+
*
|
|
2419
|
+
* const success = await unrepostPlaylist(token, 789012);
|
|
2420
|
+
* ```
|
|
2421
|
+
*
|
|
2330
2422
|
* @see https://developers.soundcloud.com/docs/api/explorer/open-api#/reposts/delete_reposts_playlists__playlist_id_
|
|
2331
2423
|
*/
|
|
2332
2424
|
declare const unrepostPlaylist: (token: string, playlistId: string | number) => Promise<boolean>;
|
|
2333
2425
|
|
|
2334
2426
|
/**
|
|
2335
2427
|
* Returns an encoded SoundCloud widget embed URL for a given track ID.
|
|
2428
|
+
*
|
|
2429
|
+
* @param trackId - The track's numeric ID or string identifier
|
|
2430
|
+
* @returns URL-encoded widget embed URL string
|
|
2431
|
+
*
|
|
2432
|
+
* @example
|
|
2433
|
+
* ```ts
|
|
2434
|
+
* import { getSoundCloudWidgetUrl } from 'soundcloud-api-ts';
|
|
2435
|
+
*
|
|
2436
|
+
* const widgetUrl = getSoundCloudWidgetUrl(123456);
|
|
2437
|
+
* console.log(widgetUrl);
|
|
2438
|
+
* ```
|
|
2336
2439
|
*/
|
|
2337
2440
|
declare const getSoundCloudWidgetUrl: (trackId: string | number) => string;
|
|
2338
2441
|
|