@rocksky/sdk 0.6.0 → 0.7.0

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.
@@ -124,6 +124,11 @@ export interface AddItemsToQueueParams {
124
124
  shuffle?: boolean;
125
125
  }
126
126
 
127
+ export interface AlbumGetAlbumParams {
128
+ /** The URI of the album to retrieve. */
129
+ uri: AtUri;
130
+ }
131
+
127
132
  export interface AlbumRecord {
128
133
  /** The title of the album. */
129
134
  title: string;
@@ -218,6 +223,26 @@ export interface ApiKeyView {
218
223
  createdAt?: DateTime;
219
224
  }
220
225
 
226
+ export interface ArtistGetArtistParams {
227
+ /** The URI of the artist to retrieve details from */
228
+ uri: AtUri;
229
+ }
230
+
231
+ export interface ArtistGetArtistsOutput {
232
+ artists?: ArtistViewBasic[];
233
+ }
234
+
235
+ export interface ArtistGetArtistsParams {
236
+ /** The maximum number of artists to return */
237
+ limit?: number;
238
+ /** The offset for pagination */
239
+ offset?: number;
240
+ /** The names of the artists to return */
241
+ names?: string;
242
+ /** The genre to filter artists by */
243
+ genre?: string;
244
+ }
245
+
221
246
  export interface ArtistListenerViewBasic {
222
247
  /** The unique identifier of the actor. */
223
248
  id?: string;
@@ -344,13 +369,6 @@ export interface CreateApikeyInput {
344
369
  description?: string;
345
370
  }
346
371
 
347
- export interface CreatePlaylistParams {
348
- /** The name of the playlist */
349
- name: string;
350
- /** A brief description of the playlist */
351
- description?: string;
352
- }
353
-
354
372
  export interface CreateScrobbleInput {
355
373
  /** The title of the track being scrobbled */
356
374
  title: string;
@@ -434,6 +452,39 @@ export interface CreateSongInput {
434
452
  lyrics?: string;
435
453
  }
436
454
 
455
+ export interface DeleteAlbumInput {
456
+ /** The album id (album xata_id, as exposed by the library API). */
457
+ id: string;
458
+ }
459
+
460
+ export interface DeleteAlbumOutput {
461
+ /** Always "ok" on success. */
462
+ status: string;
463
+ /** Number of uploads deleted for the album. */
464
+ deleted: number;
465
+ }
466
+
467
+ export interface DeletePlaylistInput {
468
+ /** The playlist id to delete. */
469
+ id: string;
470
+ }
471
+
472
+ export interface DeletePlaylistOutput {
473
+
474
+ }
475
+
476
+ export interface DeleteSongInput {
477
+ /** The song id (track xata_id, as exposed by the library API). */
478
+ id: string;
479
+ }
480
+
481
+ export interface DeleteSongOutput {
482
+ /** Always "ok" on success. */
483
+ status: string;
484
+ /** Number of uploads deleted (0 or 1). */
485
+ deleted: number;
486
+ }
487
+
437
488
  export interface DescribeFeedGeneratorOutput {
438
489
  /** The DID of the feed generator. */
439
490
  did?: AtIdentifier;
@@ -455,7 +506,7 @@ export interface DislikeSongInput {
455
506
  uri?: AtUri;
456
507
  }
457
508
 
458
- export interface DownloadFileParams {
509
+ export interface DropboxDownloadFileParams {
459
510
  /** The unique identifier of the file to download */
460
511
  fileId: string;
461
512
  }
@@ -480,6 +531,11 @@ export interface DropboxFileView {
480
531
  serverModified?: DateTime;
481
532
  }
482
533
 
534
+ export interface DropboxGetFilesParams {
535
+ /** Path to the Dropbox folder or root directory */
536
+ at?: string;
537
+ }
538
+
483
539
  export interface DropboxTemporaryLinkView {
484
540
  /** The temporary link to access the file. */
485
541
  link?: Uri;
@@ -556,6 +612,11 @@ export interface FeedRecommendedArtistView {
556
612
  source?: string;
557
613
  }
558
614
 
615
+ export interface FeedSearchParams {
616
+ /** The search query string */
617
+ query: string;
618
+ }
619
+
559
620
  export interface FeedSearchResultsView {
560
621
  hits?: SongViewBasic | AlbumViewBasic | ArtistViewBasic | PlaylistViewBasic | ActorProfileViewBasic[];
561
622
  processingTimeMs?: number;
@@ -730,9 +791,32 @@ export interface GetActorSongsParams {
730
791
  endDate?: DateTime;
731
792
  }
732
793
 
733
- export interface GetAlbumParams {
734
- /** The URI of the album to retrieve. */
735
- uri: AtUri;
794
+ export interface GetAlbumInfoOutput {
795
+
796
+ }
797
+
798
+ export interface GetAlbumInfoParams {
799
+ /** The album id */
800
+ id: string;
801
+ }
802
+
803
+ export interface GetAlbumListOutput {
804
+
805
+ }
806
+
807
+ export interface GetAlbumListParams {
808
+ /** List type: newest, alphabeticalByName, alphabeticalByArtist, random, recent, byYear, byGenre, starred. */
809
+ type: string;
810
+ /** Number of albums to return (max 500). */
811
+ size?: number;
812
+ /** Offset for pagination. */
813
+ offset?: number;
814
+ /** First year in a byYear range. */
815
+ fromYear?: number;
816
+ /** Last year in a byYear range. */
817
+ toYear?: number;
818
+ /** Genre name when type is byGenre. */
819
+ genre?: string;
736
820
  }
737
821
 
738
822
  export interface GetAlbumRecommendationsParams {
@@ -796,6 +880,15 @@ export interface GetArtistAlbumsParams {
796
880
  uri: AtUri;
797
881
  }
798
882
 
883
+ export interface GetArtistInfoOutput {
884
+
885
+ }
886
+
887
+ export interface GetArtistInfoParams {
888
+ /** The artist id */
889
+ id: string;
890
+ }
891
+
799
892
  export interface GetArtistListenersOutput {
800
893
  listeners?: ArtistListenerViewBasic[];
801
894
  }
@@ -809,11 +902,6 @@ export interface GetArtistListenersParams {
809
902
  limit?: number;
810
903
  }
811
904
 
812
- export interface GetArtistParams {
813
- /** The URI of the artist to retrieve details from */
814
- uri: AtUri;
815
- }
816
-
817
905
  export interface GetArtistRecentListenersOutput {
818
906
  listeners?: ArtistRecentListenerView[];
819
907
  }
@@ -846,21 +934,6 @@ export interface GetArtistShoutsParams {
846
934
  offset?: number;
847
935
  }
848
936
 
849
- export interface GetArtistsOutput {
850
- artists?: ArtistViewBasic[];
851
- }
852
-
853
- export interface GetArtistsParams {
854
- /** The maximum number of artists to return */
855
- limit?: number;
856
- /** The offset for pagination */
857
- offset?: number;
858
- /** The names of the artists to return */
859
- names?: string;
860
- /** The genre to filter artists by */
861
- genre?: string;
862
- }
863
-
864
937
  export interface GetArtistTracksOutput {
865
938
  tracks?: SongViewBasic[];
866
939
  }
@@ -879,10 +952,26 @@ export interface GetAudioSettingsParams {
879
952
  did?: AtIdentifier;
880
953
  }
881
954
 
882
- export interface GetCurrentlyPlayingParams {
883
- playerId?: string;
884
- /** Handle or DID of the actor to retrieve the currently playing track for. If not provided, defaults to the current user. */
885
- actor?: AtIdentifier;
955
+ export interface GetCoverArtUrlOutput {
956
+ /** The resolved media or cover-art URL. */
957
+ url: Uri;
958
+ }
959
+
960
+ export interface GetCoverArtUrlParams {
961
+ /** The cover-art id (album, artist or song). */
962
+ id: string;
963
+ /** Requested square size in pixels. */
964
+ size?: number;
965
+ }
966
+
967
+ export interface GetDownloadUrlOutput {
968
+ /** The resolved media or cover-art URL. */
969
+ url: Uri;
970
+ }
971
+
972
+ export interface GetDownloadUrlParams {
973
+ /** The song id. */
974
+ id: string;
886
975
  }
887
976
 
888
977
  export interface GetFeedGeneratorOutput {
@@ -930,11 +1019,6 @@ export interface GetFileParams {
930
1019
  fileId: string;
931
1020
  }
932
1021
 
933
- export interface GetFilesParams {
934
- /** Path to the Dropbox folder or root directory */
935
- at?: string;
936
- }
937
-
938
1022
  export interface GetFollowersOutput {
939
1023
  subject: ActorProfileViewBasic;
940
1024
  followers: ActorProfileViewBasic[];
@@ -969,10 +1053,34 @@ export interface GetFollowsParams {
969
1053
  cursor?: string;
970
1054
  }
971
1055
 
1056
+ export interface GetGenresOutput {
1057
+
1058
+ }
1059
+
1060
+ export interface GetGenresParams {
1061
+
1062
+ }
1063
+
972
1064
  export interface GetGlobalStatsParams {
973
1065
 
974
1066
  }
975
1067
 
1068
+ export interface GetIndexesOutput {
1069
+
1070
+ }
1071
+
1072
+ export interface GetIndexesParams {
1073
+
1074
+ }
1075
+
1076
+ export interface GetInternetRadioStationsOutput {
1077
+
1078
+ }
1079
+
1080
+ export interface GetInternetRadioStationsParams {
1081
+
1082
+ }
1083
+
976
1084
  export interface GetKnownFollowersOutput {
977
1085
  subject: ActorProfileViewBasic;
978
1086
  followers: ActorProfileViewBasic[];
@@ -986,6 +1094,25 @@ export interface GetKnownFollowersParams {
986
1094
  cursor?: string;
987
1095
  }
988
1096
 
1097
+ export interface GetLicenseOutput {
1098
+
1099
+ }
1100
+
1101
+ export interface GetLicenseParams {
1102
+
1103
+ }
1104
+
1105
+ export interface GetLyricsOutput {
1106
+
1107
+ }
1108
+
1109
+ export interface GetLyricsParams {
1110
+ /** The artist name. */
1111
+ artist?: string;
1112
+ /** The song title. */
1113
+ title?: string;
1114
+ }
1115
+
989
1116
  export interface GetMetadataParams {
990
1117
  /** Path to the file or folder in Dropbox */
991
1118
  path: string;
@@ -999,24 +1126,41 @@ export interface GetMirrorSourcesParams {
999
1126
 
1000
1127
  }
1001
1128
 
1129
+ export interface GetMusicDirectoryOutput {
1130
+
1131
+ }
1132
+
1133
+ export interface GetMusicDirectoryParams {
1134
+ /** The directory id */
1135
+ id: string;
1136
+ }
1137
+
1138
+ export interface GetMusicFoldersOutput {
1139
+
1140
+ }
1141
+
1142
+ export interface GetMusicFoldersParams {
1143
+
1144
+ }
1145
+
1146
+ export interface GetNowPlayingOutput {
1147
+
1148
+ }
1149
+
1150
+ export interface GetNowPlayingParams {
1151
+
1152
+ }
1153
+
1002
1154
  export interface GetPlaybackQueueParams {
1003
1155
  playerId?: string;
1004
1156
  }
1005
1157
 
1006
- export interface GetPlaylistParams {
1007
- /** The URI of the playlist to retrieve. */
1008
- uri: AtUri;
1009
- }
1158
+ export interface GetPlayQueueOutput {
1010
1159
 
1011
- export interface GetPlaylistsOutput {
1012
- playlists?: PlaylistViewBasic[];
1013
1160
  }
1014
1161
 
1015
- export interface GetPlaylistsParams {
1016
- /** The maximum number of playlists to return. */
1017
- limit?: number;
1018
- /** The offset for pagination, used to skip a number of playlists. */
1019
- offset?: number;
1162
+ export interface GetPlayQueueParams {
1163
+
1020
1164
  }
1021
1165
 
1022
1166
  export interface GetProfileParams {
@@ -1037,12 +1181,35 @@ export interface GetProfileShoutsParams {
1037
1181
  limit?: number;
1038
1182
  }
1039
1183
 
1184
+ export interface GetRandomSongsOutput {
1185
+
1186
+ }
1187
+
1188
+ export interface GetRandomSongsParams {
1189
+ /** Number of songs to return (max 500). */
1190
+ size?: number;
1191
+ /** Only return songs in this genre. */
1192
+ genre?: string;
1193
+ /** Only return songs published after or in this year. */
1194
+ fromYear?: number;
1195
+ /** Only return songs published before or in this year. */
1196
+ toYear?: number;
1197
+ }
1198
+
1040
1199
  export interface GetRecommendationsParams {
1041
1200
  /** DID or handle of the user to recommend for. */
1042
1201
  did: string;
1043
1202
  limit?: number;
1044
1203
  }
1045
1204
 
1205
+ export interface GetScanStatusOutput {
1206
+
1207
+ }
1208
+
1209
+ export interface GetScanStatusParams {
1210
+
1211
+ }
1212
+
1046
1213
  export interface GetScrobbleParams {
1047
1214
  /** The unique identifier of the scrobble */
1048
1215
  uri: AtUri;
@@ -1093,15 +1260,15 @@ export interface GetShoutRepliesParams {
1093
1260
  offset?: number;
1094
1261
  }
1095
1262
 
1096
- export interface GetSongParams {
1097
- /** The AT-URI of the song to retrieve */
1098
- uri?: AtUri;
1099
- /** The MusicBrainz ID of the song to retrieve */
1100
- mbid?: string;
1101
- /** The International Standard Recording Code (ISRC) of the song to retrieve */
1102
- isrc?: string;
1103
- /** The Spotify track ID of the song to retrieve (resolved internally to the Spotify track URL) */
1104
- spotifyId?: string;
1263
+ export interface GetSimilarSongsOutput {
1264
+
1265
+ }
1266
+
1267
+ export interface GetSimilarSongsParams {
1268
+ /** The artist, album or song id */
1269
+ id: string;
1270
+ /** Number of songs to return. */
1271
+ count?: number;
1105
1272
  }
1106
1273
 
1107
1274
  export interface GetSongRecentListenersOutput {
@@ -1117,6 +1284,19 @@ export interface GetSongRecentListenersParams {
1117
1284
  limit?: number;
1118
1285
  }
1119
1286
 
1287
+ export interface GetSongsByGenreOutput {
1288
+
1289
+ }
1290
+
1291
+ export interface GetSongsByGenreParams {
1292
+ /** The genre name. */
1293
+ genre: string;
1294
+ /** Number of songs to return (max 500). */
1295
+ count?: number;
1296
+ /** Offset for pagination. */
1297
+ offset?: number;
1298
+ }
1299
+
1120
1300
  export interface GetSongsOutput {
1121
1301
  songs?: SongViewBasic[];
1122
1302
  }
@@ -1136,6 +1316,14 @@ export interface GetSongsParams {
1136
1316
  spotifyId?: string;
1137
1317
  }
1138
1318
 
1319
+ export interface GetStarredOutput {
1320
+
1321
+ }
1322
+
1323
+ export interface GetStarredParams {
1324
+
1325
+ }
1326
+
1139
1327
  export interface GetStatsParams {
1140
1328
  /** The DID or handle of the user to get stats for. */
1141
1329
  did: AtIdentifier;
@@ -1150,6 +1338,20 @@ export interface GetStoriesParams {
1150
1338
  following?: boolean;
1151
1339
  }
1152
1340
 
1341
+ export interface GetStreamUrlOutput {
1342
+ /** The resolved media or cover-art URL. */
1343
+ url: Uri;
1344
+ }
1345
+
1346
+ export interface GetStreamUrlParams {
1347
+ /** The song id. */
1348
+ id: string;
1349
+ /** Maximum bitrate (kbps); 0 means no limit. */
1350
+ maxBitRate?: number;
1351
+ /** Preferred transcode format. */
1352
+ format?: string;
1353
+ }
1354
+
1153
1355
  export interface GetTemporaryLinkParams {
1154
1356
  /** Path to the file in Dropbox */
1155
1357
  path: string;
@@ -1170,6 +1372,17 @@ export interface GetTopArtistsParams {
1170
1372
  endDate?: DateTime;
1171
1373
  }
1172
1374
 
1375
+ export interface GetTopSongsOutput {
1376
+
1377
+ }
1378
+
1379
+ export interface GetTopSongsParams {
1380
+ /** The artist name. */
1381
+ artist: string;
1382
+ /** Number of songs to return. */
1383
+ count?: number;
1384
+ }
1385
+
1173
1386
  export interface GetTopTracksOutput {
1174
1387
  tracks?: SongViewBasic[];
1175
1388
  }
@@ -1194,6 +1407,14 @@ export interface GetTrackShoutsParams {
1194
1407
  uri: AtUri;
1195
1408
  }
1196
1409
 
1410
+ export interface GetUserOutput {
1411
+
1412
+ }
1413
+
1414
+ export interface GetUserParams {
1415
+
1416
+ }
1417
+
1197
1418
  export interface GetWrappedParams {
1198
1419
  /** The DID or handle of the user */
1199
1420
  did: AtIdentifier;
@@ -1201,6 +1422,11 @@ export interface GetWrappedParams {
1201
1422
  year?: number;
1202
1423
  }
1203
1424
 
1425
+ export interface GoogledriveDownloadFileParams {
1426
+ /** The unique identifier of the file to download */
1427
+ fileId: string;
1428
+ }
1429
+
1204
1430
  export interface GoogledriveFileListView {
1205
1431
  files?: GoogledriveFileView[];
1206
1432
  }
@@ -1210,6 +1436,11 @@ export interface GoogledriveFileView {
1210
1436
  id?: string;
1211
1437
  }
1212
1438
 
1439
+ export interface GoogledriveGetFilesParams {
1440
+ /** Path to the Google Drive folder or root directory */
1441
+ at?: string;
1442
+ }
1443
+
1213
1444
  /** indicates that a handle or DID could not be resolved */
1214
1445
  export interface GraphNotFoundActor {
1215
1446
  actor: AtIdentifier;
@@ -1241,6 +1472,88 @@ export interface InsertFilesParams {
1241
1472
  position?: number;
1242
1473
  }
1243
1474
 
1475
+ export interface LibraryCreatePlaylistInput {
1476
+ /** The playlist name. */
1477
+ name: string;
1478
+ }
1479
+
1480
+ export interface LibraryCreatePlaylistOutput {
1481
+
1482
+ }
1483
+
1484
+ export interface LibraryGetAlbumOutput {
1485
+
1486
+ }
1487
+
1488
+ export interface LibraryGetAlbumParams {
1489
+ /** The album id */
1490
+ id: string;
1491
+ }
1492
+
1493
+ export interface LibraryGetArtistOutput {
1494
+
1495
+ }
1496
+
1497
+ export interface LibraryGetArtistParams {
1498
+ /** The artist id */
1499
+ id: string;
1500
+ }
1501
+
1502
+ export interface LibraryGetArtistsOutput {
1503
+
1504
+ }
1505
+
1506
+ export interface LibraryGetArtistsParams {
1507
+
1508
+ }
1509
+
1510
+ export interface LibraryGetPlaylistOutput {
1511
+
1512
+ }
1513
+
1514
+ export interface LibraryGetPlaylistParams {
1515
+ /** The playlist id */
1516
+ id: string;
1517
+ }
1518
+
1519
+ export interface LibraryGetPlaylistsOutput {
1520
+
1521
+ }
1522
+
1523
+ export interface LibraryGetPlaylistsParams {
1524
+
1525
+ }
1526
+
1527
+ export interface LibraryGetSongOutput {
1528
+
1529
+ }
1530
+
1531
+ export interface LibraryGetSongParams {
1532
+ /** The song id */
1533
+ id: string;
1534
+ }
1535
+
1536
+ export interface LibrarySearchOutput {
1537
+
1538
+ }
1539
+
1540
+ export interface LibrarySearchParams {
1541
+ /** The search query. */
1542
+ query: string;
1543
+ /** Maximum number of artists to return. */
1544
+ artistCount?: number;
1545
+ /** Artist result offset. */
1546
+ artistOffset?: number;
1547
+ /** Maximum number of albums to return. */
1548
+ albumCount?: number;
1549
+ /** Album result offset. */
1550
+ albumOffset?: number;
1551
+ /** Maximum number of songs to return. */
1552
+ songCount?: number;
1553
+ /** Song result offset. */
1554
+ songOffset?: number;
1555
+ }
1556
+
1244
1557
  export interface LikeRecord {
1245
1558
  /** The date when the like was created. */
1246
1559
  createdAt: DateTime;
@@ -1283,12 +1596,12 @@ export interface MirrorSourceView {
1283
1596
  lastScrobbleSeenAt?: DateTime;
1284
1597
  }
1285
1598
 
1286
- export interface NextParams {
1287
- playerId?: string;
1599
+ export interface PingOutput {
1600
+
1288
1601
  }
1289
1602
 
1290
- export interface PauseParams {
1291
- playerId?: string;
1603
+ export interface PingParams {
1604
+
1292
1605
  }
1293
1606
 
1294
1607
  export interface PlayDirectoryParams {
@@ -1304,15 +1617,66 @@ export interface PlayerCurrentlyPlayingViewDetailed {
1304
1617
  title?: string;
1305
1618
  }
1306
1619
 
1620
+ export interface PlayerGetCurrentlyPlayingParams {
1621
+ playerId?: string;
1622
+ /** Handle or DID of the actor to retrieve the currently playing track for. If not provided, defaults to the current user. */
1623
+ actor?: AtIdentifier;
1624
+ }
1625
+
1626
+ export interface PlayerNextParams {
1627
+ playerId?: string;
1628
+ }
1629
+
1630
+ export interface PlayerPauseParams {
1631
+ playerId?: string;
1632
+ }
1633
+
1307
1634
  export interface PlayerPlaybackQueueViewDetailed {
1308
1635
  tracks?: SongViewBasic[];
1309
1636
  }
1310
1637
 
1638
+ export interface PlayerPlayParams {
1639
+ playerId?: string;
1640
+ }
1641
+
1642
+ export interface PlayerPreviousParams {
1643
+ playerId?: string;
1644
+ }
1645
+
1646
+ export interface PlayerSeekParams {
1647
+ playerId?: string;
1648
+ /** The position in seconds to seek to */
1649
+ position: number;
1650
+ }
1651
+
1311
1652
  export interface PlayFileParams {
1312
1653
  playerId?: string;
1313
1654
  fileId: string;
1314
1655
  }
1315
1656
 
1657
+ export interface PlaylistCreatePlaylistParams {
1658
+ /** The name of the playlist */
1659
+ name: string;
1660
+ /** A brief description of the playlist */
1661
+ description?: string;
1662
+ }
1663
+
1664
+ export interface PlaylistGetPlaylistParams {
1665
+ /** The URI of the playlist to retrieve. */
1666
+ uri: AtUri;
1667
+ }
1668
+
1669
+ export interface PlaylistGetPlaylistsOutput {
1670
+ playlists?: PlaylistViewBasic[];
1671
+ }
1672
+
1673
+ export interface PlaylistGetPlaylistsParams {
1674
+ /** The maximum number of playlists to return. */
1675
+ limit?: number;
1676
+ /** The offset for pagination, used to skip a number of playlists. */
1677
+ offset?: number;
1678
+ }
1679
+
1316
1680
  export interface PlaylistItemRecord {
1317
1681
  subject: StrongRef;
1318
1682
  /** The date the playlist was created. */
@@ -1395,14 +1759,6 @@ export interface PlaylistViewDetailed {
1395
1759
  tracks?: SongViewBasic[];
1396
1760
  }
1397
1761
 
1398
- export interface PlayParams {
1399
- playerId?: string;
1400
- }
1401
-
1402
- export interface PreviousParams {
1403
- playerId?: string;
1404
- }
1405
-
1406
1762
  export interface ProfileRecord {
1407
1763
  displayName?: string;
1408
1764
  /** Free-form profile description text. */
@@ -1590,6 +1946,19 @@ export interface RockboxToneSettings {
1590
1946
  channels?: string;
1591
1947
  }
1592
1948
 
1949
+ export interface SavePlayQueueInput {
1950
+ /** Comma-separated song ids in the queue. */
1951
+ id?: string;
1952
+ /** The id of the currently playing song. */
1953
+ current?: string;
1954
+ /** Position within the current song, in milliseconds. */
1955
+ position?: number;
1956
+ }
1957
+
1958
+ export interface SavePlayQueueOutput {
1959
+
1960
+ }
1961
+
1593
1962
  export interface ScrobbleFirstScrobbleView {
1594
1963
  /** The handle of the user who first scrobbled this song. */
1595
1964
  handle?: string;
@@ -1599,6 +1968,19 @@ export interface ScrobbleFirstScrobbleView {
1599
1968
  timestamp?: DateTime;
1600
1969
  }
1601
1970
 
1971
+ export interface ScrobbleInput {
1972
+ /** The song id. */
1973
+ id: string;
1974
+ /** Play time as a Unix timestamp in milliseconds. */
1975
+ time?: number;
1976
+ /** True for a final submission, false for a now-playing update. */
1977
+ submission?: boolean;
1978
+ }
1979
+
1980
+ export interface ScrobbleOutput {
1981
+
1982
+ }
1983
+
1602
1984
  export interface ScrobbleRecord {
1603
1985
  /** The title of the song. */
1604
1986
  title: string;
@@ -1725,17 +2107,6 @@ export interface ScrobbleViewDetailed {
1725
2107
  firstScrobble?: ScrobbleFirstScrobbleView;
1726
2108
  }
1727
2109
 
1728
- export interface SearchParams {
1729
- /** The search query string */
1730
- query: string;
1731
- }
1732
-
1733
- export interface SeekParams {
1734
- playerId?: string;
1735
- /** The position in seconds to seek to */
1736
- position: number;
1737
- }
1738
-
1739
2110
  export interface SettingsRecord {
1740
2111
  /** Crossfade settings */
1741
2112
  crossfade?: RockboxCrossfadeSettings;
@@ -1795,6 +2166,17 @@ export interface SongFirstScrobbleView {
1795
2166
  timestamp?: DateTime;
1796
2167
  }
1797
2168
 
2169
+ export interface SongGetSongParams {
2170
+ /** The AT-URI of the song to retrieve */
2171
+ uri?: AtUri;
2172
+ /** The MusicBrainz ID of the song to retrieve */
2173
+ mbid?: string;
2174
+ /** The International Standard Recording Code (ISRC) of the song to retrieve */
2175
+ isrc?: string;
2176
+ /** The Spotify track ID of the song to retrieve (resolved internally to the Spotify track URL) */
2177
+ spotifyId?: string;
2178
+ }
2179
+
1798
2180
  export interface SongRecentListenerView {
1799
2181
  /** The unique identifier of the listener. */
1800
2182
  id?: string;
@@ -1950,6 +2332,16 @@ export interface SongViewDetailed {
1950
2332
  firstScrobble?: SongFirstScrobbleView;
1951
2333
  }
1952
2334
 
2335
+ export interface SpotifyGetCurrentlyPlayingParams {
2336
+ /** Handle or DID of the actor to retrieve the currently playing track for. If not provided, defaults to the current user. */
2337
+ actor?: AtIdentifier;
2338
+ }
2339
+
2340
+ export interface SpotifySeekParams {
2341
+ /** The position in seconds to seek to */
2342
+ position: number;
2343
+ }
2344
+
1953
2345
  export interface SpotifyTrackView {
1954
2346
  /** The unique identifier of the Spotify track. */
1955
2347
  id?: string;
@@ -1965,6 +2357,19 @@ export interface SpotifyTrackView {
1965
2357
  previewUrl?: string;
1966
2358
  }
1967
2359
 
2360
+ export interface StarInput {
2361
+ /** The song id to star. */
2362
+ id: string;
2363
+ /** An album id to star. */
2364
+ albumId?: string;
2365
+ /** An artist id to star. */
2366
+ artistId?: string;
2367
+ }
2368
+
2369
+ export interface StarOutput {
2370
+
2371
+ }
2372
+
1968
2373
  export interface StartPlaylistParams {
1969
2374
  /** The URI of the playlist to start */
1970
2375
  uri: AtUri;
@@ -1974,6 +2379,14 @@ export interface StartPlaylistParams {
1974
2379
  position?: number;
1975
2380
  }
1976
2381
 
2382
+ export interface StartScanOutput {
2383
+
2384
+ }
2385
+
2386
+ export interface StartScanParams {
2387
+
2388
+ }
2389
+
1977
2390
  export interface StatsGlobalStatsView {
1978
2391
  /** Total scrobbles across all users on Rocksky. */
1979
2392
  scrobbles?: number;
@@ -2135,6 +2548,19 @@ export interface UnfollowAccountParams {
2135
2548
  account: AtIdentifier;
2136
2549
  }
2137
2550
 
2551
+ export interface UnstarInput {
2552
+ /** The song id to unstar. */
2553
+ id: string;
2554
+ /** An album id to unstar. */
2555
+ albumId?: string;
2556
+ /** An artist id to unstar. */
2557
+ artistId?: string;
2558
+ }
2559
+
2560
+ export interface UnstarOutput {
2561
+
2562
+ }
2563
+
2138
2564
  export interface UpdateApikeyInput {
2139
2565
  /** The ID of the API key to update. */
2140
2566
  id: string;
@@ -2144,6 +2570,32 @@ export interface UpdateApikeyInput {
2144
2570
  description?: string;
2145
2571
  }
2146
2572
 
2573
+ export interface UpdateNowPlayingInput {
2574
+ /** The song id. */
2575
+ id: string;
2576
+ }
2577
+
2578
+ export interface UpdateNowPlayingOutput {
2579
+
2580
+ }
2581
+
2582
+ export interface UpdatePlaylistInput {
2583
+ /** The playlist id to update. */
2584
+ playlistId: string;
2585
+ /** New playlist name. */
2586
+ name?: string;
2587
+ /** New playlist comment. */
2588
+ comment?: string;
2589
+ /** A song id to add to the playlist. */
2590
+ songIdToAdd?: string;
2591
+ /** A track index to remove from the playlist. */
2592
+ songIndexToRemove?: number;
2593
+ }
2594
+
2595
+ export interface UpdatePlaylistOutput {
2596
+
2597
+ }
2598
+
2147
2599
  /**
2148
2600
  * Map of every XRPC method (NSID) to the type of its response body.
2149
2601
  * Endpoints with no output map to `void`. Used by the SDK to type method
@@ -2171,7 +2623,7 @@ export interface Endpoints {
2171
2623
  "app.rocksky.artist.getArtistAlbums": GetArtistAlbumsOutput;
2172
2624
  "app.rocksky.artist.getArtistListeners": GetArtistListenersOutput;
2173
2625
  "app.rocksky.artist.getArtistRecentListeners": GetArtistRecentListenersOutput;
2174
- "app.rocksky.artist.getArtists": GetArtistsOutput;
2626
+ "app.rocksky.artist.getArtists": ArtistGetArtistsOutput;
2175
2627
  "app.rocksky.artist.getArtistTracks": GetArtistTracksOutput;
2176
2628
  "app.rocksky.charts.getScrobblesChart": ChartsView;
2177
2629
  "app.rocksky.charts.getTopArtists": GetTopArtistsOutput;
@@ -2198,6 +2650,47 @@ export interface Endpoints {
2198
2650
  "app.rocksky.graph.getFollows": GetFollowsOutput;
2199
2651
  "app.rocksky.graph.getKnownFollowers": GetKnownFollowersOutput;
2200
2652
  "app.rocksky.graph.unfollowAccount": UnfollowAccountOutput;
2653
+ "app.rocksky.library.createPlaylist": LibraryCreatePlaylistOutput;
2654
+ "app.rocksky.library.deleteAlbum": DeleteAlbumOutput;
2655
+ "app.rocksky.library.deletePlaylist": DeletePlaylistOutput;
2656
+ "app.rocksky.library.deleteSong": DeleteSongOutput;
2657
+ "app.rocksky.library.getAlbum": LibraryGetAlbumOutput;
2658
+ "app.rocksky.library.getAlbumInfo": GetAlbumInfoOutput;
2659
+ "app.rocksky.library.getAlbumList": GetAlbumListOutput;
2660
+ "app.rocksky.library.getArtist": LibraryGetArtistOutput;
2661
+ "app.rocksky.library.getArtistInfo": GetArtistInfoOutput;
2662
+ "app.rocksky.library.getArtists": LibraryGetArtistsOutput;
2663
+ "app.rocksky.library.getCoverArtUrl": GetCoverArtUrlOutput;
2664
+ "app.rocksky.library.getDownloadUrl": GetDownloadUrlOutput;
2665
+ "app.rocksky.library.getGenres": GetGenresOutput;
2666
+ "app.rocksky.library.getIndexes": GetIndexesOutput;
2667
+ "app.rocksky.library.getInternetRadioStations": GetInternetRadioStationsOutput;
2668
+ "app.rocksky.library.getLicense": GetLicenseOutput;
2669
+ "app.rocksky.library.getLyrics": GetLyricsOutput;
2670
+ "app.rocksky.library.getMusicDirectory": GetMusicDirectoryOutput;
2671
+ "app.rocksky.library.getMusicFolders": GetMusicFoldersOutput;
2672
+ "app.rocksky.library.getNowPlaying": GetNowPlayingOutput;
2673
+ "app.rocksky.library.getPlaylist": LibraryGetPlaylistOutput;
2674
+ "app.rocksky.library.getPlaylists": LibraryGetPlaylistsOutput;
2675
+ "app.rocksky.library.getPlayQueue": GetPlayQueueOutput;
2676
+ "app.rocksky.library.getRandomSongs": GetRandomSongsOutput;
2677
+ "app.rocksky.library.getScanStatus": GetScanStatusOutput;
2678
+ "app.rocksky.library.getSimilarSongs": GetSimilarSongsOutput;
2679
+ "app.rocksky.library.getSong": LibraryGetSongOutput;
2680
+ "app.rocksky.library.getSongsByGenre": GetSongsByGenreOutput;
2681
+ "app.rocksky.library.getStarred": GetStarredOutput;
2682
+ "app.rocksky.library.getStreamUrl": GetStreamUrlOutput;
2683
+ "app.rocksky.library.getTopSongs": GetTopSongsOutput;
2684
+ "app.rocksky.library.getUser": GetUserOutput;
2685
+ "app.rocksky.library.ping": PingOutput;
2686
+ "app.rocksky.library.savePlayQueue": SavePlayQueueOutput;
2687
+ "app.rocksky.library.scrobble": ScrobbleOutput;
2688
+ "app.rocksky.library.search": LibrarySearchOutput;
2689
+ "app.rocksky.library.star": StarOutput;
2690
+ "app.rocksky.library.startScan": StartScanOutput;
2691
+ "app.rocksky.library.unstar": UnstarOutput;
2692
+ "app.rocksky.library.updateNowPlaying": UpdateNowPlayingOutput;
2693
+ "app.rocksky.library.updatePlaylist": UpdatePlaylistOutput;
2201
2694
  "app.rocksky.like.dislikeShout": ShoutView;
2202
2695
  "app.rocksky.like.dislikeSong": SongViewDetailed;
2203
2696
  "app.rocksky.like.likeShout": ShoutView;
@@ -2217,7 +2710,7 @@ export interface Endpoints {
2217
2710
  "app.rocksky.player.seek": void;
2218
2711
  "app.rocksky.playlist.createPlaylist": void;
2219
2712
  "app.rocksky.playlist.getPlaylist": PlaylistViewDetailed;
2220
- "app.rocksky.playlist.getPlaylists": GetPlaylistsOutput;
2713
+ "app.rocksky.playlist.getPlaylists": PlaylistGetPlaylistsOutput;
2221
2714
  "app.rocksky.playlist.insertDirectory": void;
2222
2715
  "app.rocksky.playlist.insertFiles": void;
2223
2716
  "app.rocksky.playlist.removePlaylist": void;