@rocksky/sdk 0.5.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.
- package/README.md +7 -2
- package/dist/agent.d.ts +14 -1
- package/dist/agent.d.ts.map +1 -1
- package/dist/client.d.ts +9 -1
- package/dist/client.d.ts.map +1 -1
- package/dist/generated/types.d.ts +433 -76
- package/dist/generated/types.d.ts.map +1 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +171 -1
- package/dist/library.d.ts +165 -0
- package/dist/library.d.ts.map +1 -0
- package/package.json +1 -1
- package/src/agent.ts +17 -8
- package/src/client.ts +18 -1
- package/src/generated/types.ts +578 -85
- package/src/index.ts +9 -1
- package/src/library.ts +241 -0
|
@@ -112,6 +112,10 @@ export interface AddItemsToQueueParams {
|
|
|
112
112
|
/** Whether to shuffle the added items in the queue */
|
|
113
113
|
shuffle?: boolean;
|
|
114
114
|
}
|
|
115
|
+
export interface AlbumGetAlbumParams {
|
|
116
|
+
/** The URI of the album to retrieve. */
|
|
117
|
+
uri: AtUri;
|
|
118
|
+
}
|
|
115
119
|
export interface AlbumRecord {
|
|
116
120
|
/** The title of the album. */
|
|
117
121
|
title: string;
|
|
@@ -202,6 +206,23 @@ export interface ApiKeyView {
|
|
|
202
206
|
/** The date and time when the API key was created. */
|
|
203
207
|
createdAt?: DateTime;
|
|
204
208
|
}
|
|
209
|
+
export interface ArtistGetArtistParams {
|
|
210
|
+
/** The URI of the artist to retrieve details from */
|
|
211
|
+
uri: AtUri;
|
|
212
|
+
}
|
|
213
|
+
export interface ArtistGetArtistsOutput {
|
|
214
|
+
artists?: ArtistViewBasic[];
|
|
215
|
+
}
|
|
216
|
+
export interface ArtistGetArtistsParams {
|
|
217
|
+
/** The maximum number of artists to return */
|
|
218
|
+
limit?: number;
|
|
219
|
+
/** The offset for pagination */
|
|
220
|
+
offset?: number;
|
|
221
|
+
/** The names of the artists to return */
|
|
222
|
+
names?: string;
|
|
223
|
+
/** The genre to filter artists by */
|
|
224
|
+
genre?: string;
|
|
225
|
+
}
|
|
205
226
|
export interface ArtistListenerViewBasic {
|
|
206
227
|
/** The unique identifier of the actor. */
|
|
207
228
|
id?: string;
|
|
@@ -318,12 +339,6 @@ export interface CreateApikeyInput {
|
|
|
318
339
|
/** A description for the API key. */
|
|
319
340
|
description?: string;
|
|
320
341
|
}
|
|
321
|
-
export interface CreatePlaylistParams {
|
|
322
|
-
/** The name of the playlist */
|
|
323
|
-
name: string;
|
|
324
|
-
/** A brief description of the playlist */
|
|
325
|
-
description?: string;
|
|
326
|
-
}
|
|
327
342
|
export interface CreateScrobbleInput {
|
|
328
343
|
/** The title of the track being scrobbled */
|
|
329
344
|
title: string;
|
|
@@ -404,6 +419,32 @@ export interface CreateSongInput {
|
|
|
404
419
|
/** The lyrics of the song, if available */
|
|
405
420
|
lyrics?: string;
|
|
406
421
|
}
|
|
422
|
+
export interface DeleteAlbumInput {
|
|
423
|
+
/** The album id (album xata_id, as exposed by the library API). */
|
|
424
|
+
id: string;
|
|
425
|
+
}
|
|
426
|
+
export interface DeleteAlbumOutput {
|
|
427
|
+
/** Always "ok" on success. */
|
|
428
|
+
status: string;
|
|
429
|
+
/** Number of uploads deleted for the album. */
|
|
430
|
+
deleted: number;
|
|
431
|
+
}
|
|
432
|
+
export interface DeletePlaylistInput {
|
|
433
|
+
/** The playlist id to delete. */
|
|
434
|
+
id: string;
|
|
435
|
+
}
|
|
436
|
+
export interface DeletePlaylistOutput {
|
|
437
|
+
}
|
|
438
|
+
export interface DeleteSongInput {
|
|
439
|
+
/** The song id (track xata_id, as exposed by the library API). */
|
|
440
|
+
id: string;
|
|
441
|
+
}
|
|
442
|
+
export interface DeleteSongOutput {
|
|
443
|
+
/** Always "ok" on success. */
|
|
444
|
+
status: string;
|
|
445
|
+
/** Number of uploads deleted (0 or 1). */
|
|
446
|
+
deleted: number;
|
|
447
|
+
}
|
|
407
448
|
export interface DescribeFeedGeneratorOutput {
|
|
408
449
|
/** The DID of the feed generator. */
|
|
409
450
|
did?: AtIdentifier;
|
|
@@ -420,7 +461,7 @@ export interface DislikeSongInput {
|
|
|
420
461
|
/** The unique identifier of the song to dislike */
|
|
421
462
|
uri?: AtUri;
|
|
422
463
|
}
|
|
423
|
-
export interface
|
|
464
|
+
export interface DropboxDownloadFileParams {
|
|
424
465
|
/** The unique identifier of the file to download */
|
|
425
466
|
fileId: string;
|
|
426
467
|
}
|
|
@@ -442,6 +483,10 @@ export interface DropboxFileView {
|
|
|
442
483
|
/** The last modified date and time of the file on the server. */
|
|
443
484
|
serverModified?: DateTime;
|
|
444
485
|
}
|
|
486
|
+
export interface DropboxGetFilesParams {
|
|
487
|
+
/** Path to the Dropbox folder or root directory */
|
|
488
|
+
at?: string;
|
|
489
|
+
}
|
|
445
490
|
export interface DropboxTemporaryLinkView {
|
|
446
491
|
/** The temporary link to access the file. */
|
|
447
492
|
link?: Uri;
|
|
@@ -508,6 +553,10 @@ export interface FeedRecommendedArtistView {
|
|
|
508
553
|
/** neighbour | social | serendipity */
|
|
509
554
|
source?: string;
|
|
510
555
|
}
|
|
556
|
+
export interface FeedSearchParams {
|
|
557
|
+
/** The search query string */
|
|
558
|
+
query: string;
|
|
559
|
+
}
|
|
511
560
|
export interface FeedSearchResultsView {
|
|
512
561
|
hits?: SongViewBasic | AlbumViewBasic | ArtistViewBasic | PlaylistViewBasic | ActorProfileViewBasic[];
|
|
513
562
|
processingTimeMs?: number;
|
|
@@ -657,9 +706,27 @@ export interface GetActorSongsParams {
|
|
|
657
706
|
/** The end date to filter albums to (ISO 8601 format) */
|
|
658
707
|
endDate?: DateTime;
|
|
659
708
|
}
|
|
660
|
-
export interface
|
|
661
|
-
|
|
662
|
-
|
|
709
|
+
export interface GetAlbumInfoOutput {
|
|
710
|
+
}
|
|
711
|
+
export interface GetAlbumInfoParams {
|
|
712
|
+
/** The album id */
|
|
713
|
+
id: string;
|
|
714
|
+
}
|
|
715
|
+
export interface GetAlbumListOutput {
|
|
716
|
+
}
|
|
717
|
+
export interface GetAlbumListParams {
|
|
718
|
+
/** List type: newest, alphabeticalByName, alphabeticalByArtist, random, recent, byYear, byGenre, starred. */
|
|
719
|
+
type: string;
|
|
720
|
+
/** Number of albums to return (max 500). */
|
|
721
|
+
size?: number;
|
|
722
|
+
/** Offset for pagination. */
|
|
723
|
+
offset?: number;
|
|
724
|
+
/** First year in a byYear range. */
|
|
725
|
+
fromYear?: number;
|
|
726
|
+
/** Last year in a byYear range. */
|
|
727
|
+
toYear?: number;
|
|
728
|
+
/** Genre name when type is byGenre. */
|
|
729
|
+
genre?: string;
|
|
663
730
|
}
|
|
664
731
|
export interface GetAlbumRecommendationsParams {
|
|
665
732
|
/** DID or handle of the user to recommend for. */
|
|
@@ -711,6 +778,12 @@ export interface GetArtistAlbumsParams {
|
|
|
711
778
|
/** The URI of the artist to retrieve albums from */
|
|
712
779
|
uri: AtUri;
|
|
713
780
|
}
|
|
781
|
+
export interface GetArtistInfoOutput {
|
|
782
|
+
}
|
|
783
|
+
export interface GetArtistInfoParams {
|
|
784
|
+
/** The artist id */
|
|
785
|
+
id: string;
|
|
786
|
+
}
|
|
714
787
|
export interface GetArtistListenersOutput {
|
|
715
788
|
listeners?: ArtistListenerViewBasic[];
|
|
716
789
|
}
|
|
@@ -722,10 +795,6 @@ export interface GetArtistListenersParams {
|
|
|
722
795
|
/** Maximum number of results to return */
|
|
723
796
|
limit?: number;
|
|
724
797
|
}
|
|
725
|
-
export interface GetArtistParams {
|
|
726
|
-
/** The URI of the artist to retrieve details from */
|
|
727
|
-
uri: AtUri;
|
|
728
|
-
}
|
|
729
798
|
export interface GetArtistRecentListenersOutput {
|
|
730
799
|
listeners?: ArtistRecentListenerView[];
|
|
731
800
|
}
|
|
@@ -753,19 +822,6 @@ export interface GetArtistShoutsParams {
|
|
|
753
822
|
/** The number of shouts to skip before starting to collect the result set */
|
|
754
823
|
offset?: number;
|
|
755
824
|
}
|
|
756
|
-
export interface GetArtistsOutput {
|
|
757
|
-
artists?: ArtistViewBasic[];
|
|
758
|
-
}
|
|
759
|
-
export interface GetArtistsParams {
|
|
760
|
-
/** The maximum number of artists to return */
|
|
761
|
-
limit?: number;
|
|
762
|
-
/** The offset for pagination */
|
|
763
|
-
offset?: number;
|
|
764
|
-
/** The names of the artists to return */
|
|
765
|
-
names?: string;
|
|
766
|
-
/** The genre to filter artists by */
|
|
767
|
-
genre?: string;
|
|
768
|
-
}
|
|
769
825
|
export interface GetArtistTracksOutput {
|
|
770
826
|
tracks?: SongViewBasic[];
|
|
771
827
|
}
|
|
@@ -781,10 +837,23 @@ export interface GetAudioSettingsParams {
|
|
|
781
837
|
/** DID or handle of the user whose settings to fetch. Required for unauthenticated requests. */
|
|
782
838
|
did?: AtIdentifier;
|
|
783
839
|
}
|
|
784
|
-
export interface
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
840
|
+
export interface GetCoverArtUrlOutput {
|
|
841
|
+
/** The resolved media or cover-art URL. */
|
|
842
|
+
url: Uri;
|
|
843
|
+
}
|
|
844
|
+
export interface GetCoverArtUrlParams {
|
|
845
|
+
/** The cover-art id (album, artist or song). */
|
|
846
|
+
id: string;
|
|
847
|
+
/** Requested square size in pixels. */
|
|
848
|
+
size?: number;
|
|
849
|
+
}
|
|
850
|
+
export interface GetDownloadUrlOutput {
|
|
851
|
+
/** The resolved media or cover-art URL. */
|
|
852
|
+
url: Uri;
|
|
853
|
+
}
|
|
854
|
+
export interface GetDownloadUrlParams {
|
|
855
|
+
/** The song id. */
|
|
856
|
+
id: string;
|
|
788
857
|
}
|
|
789
858
|
export interface GetFeedGeneratorOutput {
|
|
790
859
|
view?: FeedGeneratorView;
|
|
@@ -824,10 +893,6 @@ export interface GetFileParams {
|
|
|
824
893
|
/** The unique identifier of the file to retrieve */
|
|
825
894
|
fileId: string;
|
|
826
895
|
}
|
|
827
|
-
export interface GetFilesParams {
|
|
828
|
-
/** Path to the Dropbox folder or root directory */
|
|
829
|
-
at?: string;
|
|
830
|
-
}
|
|
831
896
|
export interface GetFollowersOutput {
|
|
832
897
|
subject: ActorProfileViewBasic;
|
|
833
898
|
followers: ActorProfileViewBasic[];
|
|
@@ -858,8 +923,20 @@ export interface GetFollowsParams {
|
|
|
858
923
|
dids?: Did[];
|
|
859
924
|
cursor?: string;
|
|
860
925
|
}
|
|
926
|
+
export interface GetGenresOutput {
|
|
927
|
+
}
|
|
928
|
+
export interface GetGenresParams {
|
|
929
|
+
}
|
|
861
930
|
export interface GetGlobalStatsParams {
|
|
862
931
|
}
|
|
932
|
+
export interface GetIndexesOutput {
|
|
933
|
+
}
|
|
934
|
+
export interface GetIndexesParams {
|
|
935
|
+
}
|
|
936
|
+
export interface GetInternetRadioStationsOutput {
|
|
937
|
+
}
|
|
938
|
+
export interface GetInternetRadioStationsParams {
|
|
939
|
+
}
|
|
863
940
|
export interface GetKnownFollowersOutput {
|
|
864
941
|
subject: ActorProfileViewBasic;
|
|
865
942
|
followers: ActorProfileViewBasic[];
|
|
@@ -871,6 +948,18 @@ export interface GetKnownFollowersParams {
|
|
|
871
948
|
limit?: number;
|
|
872
949
|
cursor?: string;
|
|
873
950
|
}
|
|
951
|
+
export interface GetLicenseOutput {
|
|
952
|
+
}
|
|
953
|
+
export interface GetLicenseParams {
|
|
954
|
+
}
|
|
955
|
+
export interface GetLyricsOutput {
|
|
956
|
+
}
|
|
957
|
+
export interface GetLyricsParams {
|
|
958
|
+
/** The artist name. */
|
|
959
|
+
artist?: string;
|
|
960
|
+
/** The song title. */
|
|
961
|
+
title?: string;
|
|
962
|
+
}
|
|
874
963
|
export interface GetMetadataParams {
|
|
875
964
|
/** Path to the file or folder in Dropbox */
|
|
876
965
|
path: string;
|
|
@@ -880,21 +969,26 @@ export interface GetMirrorSourcesOutput {
|
|
|
880
969
|
}
|
|
881
970
|
export interface GetMirrorSourcesParams {
|
|
882
971
|
}
|
|
972
|
+
export interface GetMusicDirectoryOutput {
|
|
973
|
+
}
|
|
974
|
+
export interface GetMusicDirectoryParams {
|
|
975
|
+
/** The directory id */
|
|
976
|
+
id: string;
|
|
977
|
+
}
|
|
978
|
+
export interface GetMusicFoldersOutput {
|
|
979
|
+
}
|
|
980
|
+
export interface GetMusicFoldersParams {
|
|
981
|
+
}
|
|
982
|
+
export interface GetNowPlayingOutput {
|
|
983
|
+
}
|
|
984
|
+
export interface GetNowPlayingParams {
|
|
985
|
+
}
|
|
883
986
|
export interface GetPlaybackQueueParams {
|
|
884
987
|
playerId?: string;
|
|
885
988
|
}
|
|
886
|
-
export interface
|
|
887
|
-
/** The URI of the playlist to retrieve. */
|
|
888
|
-
uri: AtUri;
|
|
989
|
+
export interface GetPlayQueueOutput {
|
|
889
990
|
}
|
|
890
|
-
export interface
|
|
891
|
-
playlists?: PlaylistViewBasic[];
|
|
892
|
-
}
|
|
893
|
-
export interface GetPlaylistsParams {
|
|
894
|
-
/** The maximum number of playlists to return. */
|
|
895
|
-
limit?: number;
|
|
896
|
-
/** The offset for pagination, used to skip a number of playlists. */
|
|
897
|
-
offset?: number;
|
|
991
|
+
export interface GetPlayQueueParams {
|
|
898
992
|
}
|
|
899
993
|
export interface GetProfileParams {
|
|
900
994
|
/** The DID or handle of the actor */
|
|
@@ -911,11 +1005,27 @@ export interface GetProfileShoutsParams {
|
|
|
911
1005
|
/** The maximum number of shouts to return */
|
|
912
1006
|
limit?: number;
|
|
913
1007
|
}
|
|
1008
|
+
export interface GetRandomSongsOutput {
|
|
1009
|
+
}
|
|
1010
|
+
export interface GetRandomSongsParams {
|
|
1011
|
+
/** Number of songs to return (max 500). */
|
|
1012
|
+
size?: number;
|
|
1013
|
+
/** Only return songs in this genre. */
|
|
1014
|
+
genre?: string;
|
|
1015
|
+
/** Only return songs published after or in this year. */
|
|
1016
|
+
fromYear?: number;
|
|
1017
|
+
/** Only return songs published before or in this year. */
|
|
1018
|
+
toYear?: number;
|
|
1019
|
+
}
|
|
914
1020
|
export interface GetRecommendationsParams {
|
|
915
1021
|
/** DID or handle of the user to recommend for. */
|
|
916
1022
|
did: string;
|
|
917
1023
|
limit?: number;
|
|
918
1024
|
}
|
|
1025
|
+
export interface GetScanStatusOutput {
|
|
1026
|
+
}
|
|
1027
|
+
export interface GetScanStatusParams {
|
|
1028
|
+
}
|
|
919
1029
|
export interface GetScrobbleParams {
|
|
920
1030
|
/** The unique identifier of the scrobble */
|
|
921
1031
|
uri: AtUri;
|
|
@@ -960,15 +1070,13 @@ export interface GetShoutRepliesParams {
|
|
|
960
1070
|
/** The number of shouts to skip before starting to collect the result set */
|
|
961
1071
|
offset?: number;
|
|
962
1072
|
}
|
|
963
|
-
export interface
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
/** The
|
|
967
|
-
|
|
968
|
-
/**
|
|
969
|
-
|
|
970
|
-
/** The Spotify track ID of the song to retrieve (resolved internally to the Spotify track URL) */
|
|
971
|
-
spotifyId?: string;
|
|
1073
|
+
export interface GetSimilarSongsOutput {
|
|
1074
|
+
}
|
|
1075
|
+
export interface GetSimilarSongsParams {
|
|
1076
|
+
/** The artist, album or song id */
|
|
1077
|
+
id: string;
|
|
1078
|
+
/** Number of songs to return. */
|
|
1079
|
+
count?: number;
|
|
972
1080
|
}
|
|
973
1081
|
export interface GetSongRecentListenersOutput {
|
|
974
1082
|
listeners?: SongRecentListenerView[];
|
|
@@ -981,6 +1089,16 @@ export interface GetSongRecentListenersParams {
|
|
|
981
1089
|
/** Maximum number of results to return */
|
|
982
1090
|
limit?: number;
|
|
983
1091
|
}
|
|
1092
|
+
export interface GetSongsByGenreOutput {
|
|
1093
|
+
}
|
|
1094
|
+
export interface GetSongsByGenreParams {
|
|
1095
|
+
/** The genre name. */
|
|
1096
|
+
genre: string;
|
|
1097
|
+
/** Number of songs to return (max 500). */
|
|
1098
|
+
count?: number;
|
|
1099
|
+
/** Offset for pagination. */
|
|
1100
|
+
offset?: number;
|
|
1101
|
+
}
|
|
984
1102
|
export interface GetSongsOutput {
|
|
985
1103
|
songs?: SongViewBasic[];
|
|
986
1104
|
}
|
|
@@ -998,6 +1116,10 @@ export interface GetSongsParams {
|
|
|
998
1116
|
/** Filter songs by Spotify track ID (resolved internally to the Spotify track URL) */
|
|
999
1117
|
spotifyId?: string;
|
|
1000
1118
|
}
|
|
1119
|
+
export interface GetStarredOutput {
|
|
1120
|
+
}
|
|
1121
|
+
export interface GetStarredParams {
|
|
1122
|
+
}
|
|
1001
1123
|
export interface GetStatsParams {
|
|
1002
1124
|
/** The DID or handle of the user to get stats for. */
|
|
1003
1125
|
did: AtIdentifier;
|
|
@@ -1010,6 +1132,18 @@ export interface GetStoriesParams {
|
|
|
1010
1132
|
/** If true, only return stories from users the viewer follows. Requires authentication. */
|
|
1011
1133
|
following?: boolean;
|
|
1012
1134
|
}
|
|
1135
|
+
export interface GetStreamUrlOutput {
|
|
1136
|
+
/** The resolved media or cover-art URL. */
|
|
1137
|
+
url: Uri;
|
|
1138
|
+
}
|
|
1139
|
+
export interface GetStreamUrlParams {
|
|
1140
|
+
/** The song id. */
|
|
1141
|
+
id: string;
|
|
1142
|
+
/** Maximum bitrate (kbps); 0 means no limit. */
|
|
1143
|
+
maxBitRate?: number;
|
|
1144
|
+
/** Preferred transcode format. */
|
|
1145
|
+
format?: string;
|
|
1146
|
+
}
|
|
1013
1147
|
export interface GetTemporaryLinkParams {
|
|
1014
1148
|
/** Path to the file in Dropbox */
|
|
1015
1149
|
path: string;
|
|
@@ -1027,6 +1161,14 @@ export interface GetTopArtistsParams {
|
|
|
1027
1161
|
/** The end date to filter artists to (ISO 8601 format) */
|
|
1028
1162
|
endDate?: DateTime;
|
|
1029
1163
|
}
|
|
1164
|
+
export interface GetTopSongsOutput {
|
|
1165
|
+
}
|
|
1166
|
+
export interface GetTopSongsParams {
|
|
1167
|
+
/** The artist name. */
|
|
1168
|
+
artist: string;
|
|
1169
|
+
/** Number of songs to return. */
|
|
1170
|
+
count?: number;
|
|
1171
|
+
}
|
|
1030
1172
|
export interface GetTopTracksOutput {
|
|
1031
1173
|
tracks?: SongViewBasic[];
|
|
1032
1174
|
}
|
|
@@ -1047,12 +1189,20 @@ export interface GetTrackShoutsParams {
|
|
|
1047
1189
|
/** The URI of the track to retrieve shouts for */
|
|
1048
1190
|
uri: AtUri;
|
|
1049
1191
|
}
|
|
1192
|
+
export interface GetUserOutput {
|
|
1193
|
+
}
|
|
1194
|
+
export interface GetUserParams {
|
|
1195
|
+
}
|
|
1050
1196
|
export interface GetWrappedParams {
|
|
1051
1197
|
/** The DID or handle of the user */
|
|
1052
1198
|
did: AtIdentifier;
|
|
1053
1199
|
/** The year to get wrapped stats for (defaults to current year) */
|
|
1054
1200
|
year?: number;
|
|
1055
1201
|
}
|
|
1202
|
+
export interface GoogledriveDownloadFileParams {
|
|
1203
|
+
/** The unique identifier of the file to download */
|
|
1204
|
+
fileId: string;
|
|
1205
|
+
}
|
|
1056
1206
|
export interface GoogledriveFileListView {
|
|
1057
1207
|
files?: GoogledriveFileView[];
|
|
1058
1208
|
}
|
|
@@ -1060,6 +1210,10 @@ export interface GoogledriveFileView {
|
|
|
1060
1210
|
/** The unique identifier of the file. */
|
|
1061
1211
|
id?: string;
|
|
1062
1212
|
}
|
|
1213
|
+
export interface GoogledriveGetFilesParams {
|
|
1214
|
+
/** Path to the Google Drive folder or root directory */
|
|
1215
|
+
at?: string;
|
|
1216
|
+
}
|
|
1063
1217
|
/** indicates that a handle or DID could not be resolved */
|
|
1064
1218
|
export interface GraphNotFoundActor {
|
|
1065
1219
|
actor: AtIdentifier;
|
|
@@ -1087,6 +1241,62 @@ export interface InsertFilesParams {
|
|
|
1087
1241
|
/** The position in the playlist to insert the files at, if not specified, files will be appended */
|
|
1088
1242
|
position?: number;
|
|
1089
1243
|
}
|
|
1244
|
+
export interface LibraryCreatePlaylistInput {
|
|
1245
|
+
/** The playlist name. */
|
|
1246
|
+
name: string;
|
|
1247
|
+
}
|
|
1248
|
+
export interface LibraryCreatePlaylistOutput {
|
|
1249
|
+
}
|
|
1250
|
+
export interface LibraryGetAlbumOutput {
|
|
1251
|
+
}
|
|
1252
|
+
export interface LibraryGetAlbumParams {
|
|
1253
|
+
/** The album id */
|
|
1254
|
+
id: string;
|
|
1255
|
+
}
|
|
1256
|
+
export interface LibraryGetArtistOutput {
|
|
1257
|
+
}
|
|
1258
|
+
export interface LibraryGetArtistParams {
|
|
1259
|
+
/** The artist id */
|
|
1260
|
+
id: string;
|
|
1261
|
+
}
|
|
1262
|
+
export interface LibraryGetArtistsOutput {
|
|
1263
|
+
}
|
|
1264
|
+
export interface LibraryGetArtistsParams {
|
|
1265
|
+
}
|
|
1266
|
+
export interface LibraryGetPlaylistOutput {
|
|
1267
|
+
}
|
|
1268
|
+
export interface LibraryGetPlaylistParams {
|
|
1269
|
+
/** The playlist id */
|
|
1270
|
+
id: string;
|
|
1271
|
+
}
|
|
1272
|
+
export interface LibraryGetPlaylistsOutput {
|
|
1273
|
+
}
|
|
1274
|
+
export interface LibraryGetPlaylistsParams {
|
|
1275
|
+
}
|
|
1276
|
+
export interface LibraryGetSongOutput {
|
|
1277
|
+
}
|
|
1278
|
+
export interface LibraryGetSongParams {
|
|
1279
|
+
/** The song id */
|
|
1280
|
+
id: string;
|
|
1281
|
+
}
|
|
1282
|
+
export interface LibrarySearchOutput {
|
|
1283
|
+
}
|
|
1284
|
+
export interface LibrarySearchParams {
|
|
1285
|
+
/** The search query. */
|
|
1286
|
+
query: string;
|
|
1287
|
+
/** Maximum number of artists to return. */
|
|
1288
|
+
artistCount?: number;
|
|
1289
|
+
/** Artist result offset. */
|
|
1290
|
+
artistOffset?: number;
|
|
1291
|
+
/** Maximum number of albums to return. */
|
|
1292
|
+
albumCount?: number;
|
|
1293
|
+
/** Album result offset. */
|
|
1294
|
+
albumOffset?: number;
|
|
1295
|
+
/** Maximum number of songs to return. */
|
|
1296
|
+
songCount?: number;
|
|
1297
|
+
/** Song result offset. */
|
|
1298
|
+
songOffset?: number;
|
|
1299
|
+
}
|
|
1090
1300
|
export interface LikeRecord {
|
|
1091
1301
|
/** The date when the like was created. */
|
|
1092
1302
|
createdAt: DateTime;
|
|
@@ -1124,11 +1334,9 @@ export interface MirrorSourceView {
|
|
|
1124
1334
|
/** Watermark — scrobbles from the external service older than this are skipped. */
|
|
1125
1335
|
lastScrobbleSeenAt?: DateTime;
|
|
1126
1336
|
}
|
|
1127
|
-
export interface
|
|
1128
|
-
playerId?: string;
|
|
1337
|
+
export interface PingOutput {
|
|
1129
1338
|
}
|
|
1130
|
-
export interface
|
|
1131
|
-
playerId?: string;
|
|
1339
|
+
export interface PingParams {
|
|
1132
1340
|
}
|
|
1133
1341
|
export interface PlayDirectoryParams {
|
|
1134
1342
|
playerId?: string;
|
|
@@ -1141,13 +1349,54 @@ export interface PlayerCurrentlyPlayingViewDetailed {
|
|
|
1141
1349
|
/** The title of the currently playing track */
|
|
1142
1350
|
title?: string;
|
|
1143
1351
|
}
|
|
1352
|
+
export interface PlayerGetCurrentlyPlayingParams {
|
|
1353
|
+
playerId?: string;
|
|
1354
|
+
/** Handle or DID of the actor to retrieve the currently playing track for. If not provided, defaults to the current user. */
|
|
1355
|
+
actor?: AtIdentifier;
|
|
1356
|
+
}
|
|
1357
|
+
export interface PlayerNextParams {
|
|
1358
|
+
playerId?: string;
|
|
1359
|
+
}
|
|
1360
|
+
export interface PlayerPauseParams {
|
|
1361
|
+
playerId?: string;
|
|
1362
|
+
}
|
|
1144
1363
|
export interface PlayerPlaybackQueueViewDetailed {
|
|
1145
1364
|
tracks?: SongViewBasic[];
|
|
1146
1365
|
}
|
|
1366
|
+
export interface PlayerPlayParams {
|
|
1367
|
+
playerId?: string;
|
|
1368
|
+
}
|
|
1369
|
+
export interface PlayerPreviousParams {
|
|
1370
|
+
playerId?: string;
|
|
1371
|
+
}
|
|
1372
|
+
export interface PlayerSeekParams {
|
|
1373
|
+
playerId?: string;
|
|
1374
|
+
/** The position in seconds to seek to */
|
|
1375
|
+
position: number;
|
|
1376
|
+
}
|
|
1147
1377
|
export interface PlayFileParams {
|
|
1148
1378
|
playerId?: string;
|
|
1149
1379
|
fileId: string;
|
|
1150
1380
|
}
|
|
1381
|
+
export interface PlaylistCreatePlaylistParams {
|
|
1382
|
+
/** The name of the playlist */
|
|
1383
|
+
name: string;
|
|
1384
|
+
/** A brief description of the playlist */
|
|
1385
|
+
description?: string;
|
|
1386
|
+
}
|
|
1387
|
+
export interface PlaylistGetPlaylistParams {
|
|
1388
|
+
/** The URI of the playlist to retrieve. */
|
|
1389
|
+
uri: AtUri;
|
|
1390
|
+
}
|
|
1391
|
+
export interface PlaylistGetPlaylistsOutput {
|
|
1392
|
+
playlists?: PlaylistViewBasic[];
|
|
1393
|
+
}
|
|
1394
|
+
export interface PlaylistGetPlaylistsParams {
|
|
1395
|
+
/** The maximum number of playlists to return. */
|
|
1396
|
+
limit?: number;
|
|
1397
|
+
/** The offset for pagination, used to skip a number of playlists. */
|
|
1398
|
+
offset?: number;
|
|
1399
|
+
}
|
|
1151
1400
|
export interface PlaylistItemRecord {
|
|
1152
1401
|
subject: StrongRef;
|
|
1153
1402
|
/** The date the playlist was created. */
|
|
@@ -1226,12 +1475,6 @@ export interface PlaylistViewDetailed {
|
|
|
1226
1475
|
/** A list of tracks in the playlist. */
|
|
1227
1476
|
tracks?: SongViewBasic[];
|
|
1228
1477
|
}
|
|
1229
|
-
export interface PlayParams {
|
|
1230
|
-
playerId?: string;
|
|
1231
|
-
}
|
|
1232
|
-
export interface PreviousParams {
|
|
1233
|
-
playerId?: string;
|
|
1234
|
-
}
|
|
1235
1478
|
export interface ProfileRecord {
|
|
1236
1479
|
displayName?: string;
|
|
1237
1480
|
/** Free-form profile description text. */
|
|
@@ -1401,6 +1644,16 @@ export interface RockboxToneSettings {
|
|
|
1401
1644
|
/** Channel configuration: stereo | mono | monoLeft | monoRight | karaoke | wide */
|
|
1402
1645
|
channels?: string;
|
|
1403
1646
|
}
|
|
1647
|
+
export interface SavePlayQueueInput {
|
|
1648
|
+
/** Comma-separated song ids in the queue. */
|
|
1649
|
+
id?: string;
|
|
1650
|
+
/** The id of the currently playing song. */
|
|
1651
|
+
current?: string;
|
|
1652
|
+
/** Position within the current song, in milliseconds. */
|
|
1653
|
+
position?: number;
|
|
1654
|
+
}
|
|
1655
|
+
export interface SavePlayQueueOutput {
|
|
1656
|
+
}
|
|
1404
1657
|
export interface ScrobbleFirstScrobbleView {
|
|
1405
1658
|
/** The handle of the user who first scrobbled this song. */
|
|
1406
1659
|
handle?: string;
|
|
@@ -1409,6 +1662,16 @@ export interface ScrobbleFirstScrobbleView {
|
|
|
1409
1662
|
/** The timestamp of the first scrobble. */
|
|
1410
1663
|
timestamp?: DateTime;
|
|
1411
1664
|
}
|
|
1665
|
+
export interface ScrobbleInput {
|
|
1666
|
+
/** The song id. */
|
|
1667
|
+
id: string;
|
|
1668
|
+
/** Play time as a Unix timestamp in milliseconds. */
|
|
1669
|
+
time?: number;
|
|
1670
|
+
/** True for a final submission, false for a now-playing update. */
|
|
1671
|
+
submission?: boolean;
|
|
1672
|
+
}
|
|
1673
|
+
export interface ScrobbleOutput {
|
|
1674
|
+
}
|
|
1412
1675
|
export interface ScrobbleRecord {
|
|
1413
1676
|
/** The title of the song. */
|
|
1414
1677
|
title: string;
|
|
@@ -1532,15 +1795,6 @@ export interface ScrobbleViewDetailed {
|
|
|
1532
1795
|
/** The first scrobble of this song on Rocksky. */
|
|
1533
1796
|
firstScrobble?: ScrobbleFirstScrobbleView;
|
|
1534
1797
|
}
|
|
1535
|
-
export interface SearchParams {
|
|
1536
|
-
/** The search query string */
|
|
1537
|
-
query: string;
|
|
1538
|
-
}
|
|
1539
|
-
export interface SeekParams {
|
|
1540
|
-
playerId?: string;
|
|
1541
|
-
/** The position in seconds to seek to */
|
|
1542
|
-
position: number;
|
|
1543
|
-
}
|
|
1544
1798
|
export interface SettingsRecord {
|
|
1545
1799
|
/** Crossfade settings */
|
|
1546
1800
|
crossfade?: RockboxCrossfadeSettings;
|
|
@@ -1595,6 +1849,16 @@ export interface SongFirstScrobbleView {
|
|
|
1595
1849
|
/** The timestamp of the first scrobble. */
|
|
1596
1850
|
timestamp?: DateTime;
|
|
1597
1851
|
}
|
|
1852
|
+
export interface SongGetSongParams {
|
|
1853
|
+
/** The AT-URI of the song to retrieve */
|
|
1854
|
+
uri?: AtUri;
|
|
1855
|
+
/** The MusicBrainz ID of the song to retrieve */
|
|
1856
|
+
mbid?: string;
|
|
1857
|
+
/** The International Standard Recording Code (ISRC) of the song to retrieve */
|
|
1858
|
+
isrc?: string;
|
|
1859
|
+
/** The Spotify track ID of the song to retrieve (resolved internally to the Spotify track URL) */
|
|
1860
|
+
spotifyId?: string;
|
|
1861
|
+
}
|
|
1598
1862
|
export interface SongRecentListenerView {
|
|
1599
1863
|
/** The unique identifier of the listener. */
|
|
1600
1864
|
id?: string;
|
|
@@ -1746,6 +2010,14 @@ export interface SongViewDetailed {
|
|
|
1746
2010
|
/** The first scrobble of this song on Rocksky. */
|
|
1747
2011
|
firstScrobble?: SongFirstScrobbleView;
|
|
1748
2012
|
}
|
|
2013
|
+
export interface SpotifyGetCurrentlyPlayingParams {
|
|
2014
|
+
/** Handle or DID of the actor to retrieve the currently playing track for. If not provided, defaults to the current user. */
|
|
2015
|
+
actor?: AtIdentifier;
|
|
2016
|
+
}
|
|
2017
|
+
export interface SpotifySeekParams {
|
|
2018
|
+
/** The position in seconds to seek to */
|
|
2019
|
+
position: number;
|
|
2020
|
+
}
|
|
1749
2021
|
export interface SpotifyTrackView {
|
|
1750
2022
|
/** The unique identifier of the Spotify track. */
|
|
1751
2023
|
id?: string;
|
|
@@ -1760,6 +2032,16 @@ export interface SpotifyTrackView {
|
|
|
1760
2032
|
/** A URL to a preview of the track. */
|
|
1761
2033
|
previewUrl?: string;
|
|
1762
2034
|
}
|
|
2035
|
+
export interface StarInput {
|
|
2036
|
+
/** The song id to star. */
|
|
2037
|
+
id: string;
|
|
2038
|
+
/** An album id to star. */
|
|
2039
|
+
albumId?: string;
|
|
2040
|
+
/** An artist id to star. */
|
|
2041
|
+
artistId?: string;
|
|
2042
|
+
}
|
|
2043
|
+
export interface StarOutput {
|
|
2044
|
+
}
|
|
1763
2045
|
export interface StartPlaylistParams {
|
|
1764
2046
|
/** The URI of the playlist to start */
|
|
1765
2047
|
uri: AtUri;
|
|
@@ -1768,6 +2050,10 @@ export interface StartPlaylistParams {
|
|
|
1768
2050
|
/** The position in the playlist to start from, if not specified, starts from the beginning */
|
|
1769
2051
|
position?: number;
|
|
1770
2052
|
}
|
|
2053
|
+
export interface StartScanOutput {
|
|
2054
|
+
}
|
|
2055
|
+
export interface StartScanParams {
|
|
2056
|
+
}
|
|
1771
2057
|
export interface StatsGlobalStatsView {
|
|
1772
2058
|
/** Total scrobbles across all users on Rocksky. */
|
|
1773
2059
|
scrobbles?: number;
|
|
@@ -1915,6 +2201,16 @@ export interface UnfollowAccountOutput {
|
|
|
1915
2201
|
export interface UnfollowAccountParams {
|
|
1916
2202
|
account: AtIdentifier;
|
|
1917
2203
|
}
|
|
2204
|
+
export interface UnstarInput {
|
|
2205
|
+
/** The song id to unstar. */
|
|
2206
|
+
id: string;
|
|
2207
|
+
/** An album id to unstar. */
|
|
2208
|
+
albumId?: string;
|
|
2209
|
+
/** An artist id to unstar. */
|
|
2210
|
+
artistId?: string;
|
|
2211
|
+
}
|
|
2212
|
+
export interface UnstarOutput {
|
|
2213
|
+
}
|
|
1918
2214
|
export interface UpdateApikeyInput {
|
|
1919
2215
|
/** The ID of the API key to update. */
|
|
1920
2216
|
id: string;
|
|
@@ -1923,6 +2219,26 @@ export interface UpdateApikeyInput {
|
|
|
1923
2219
|
/** A new description for the API key. */
|
|
1924
2220
|
description?: string;
|
|
1925
2221
|
}
|
|
2222
|
+
export interface UpdateNowPlayingInput {
|
|
2223
|
+
/** The song id. */
|
|
2224
|
+
id: string;
|
|
2225
|
+
}
|
|
2226
|
+
export interface UpdateNowPlayingOutput {
|
|
2227
|
+
}
|
|
2228
|
+
export interface UpdatePlaylistInput {
|
|
2229
|
+
/** The playlist id to update. */
|
|
2230
|
+
playlistId: string;
|
|
2231
|
+
/** New playlist name. */
|
|
2232
|
+
name?: string;
|
|
2233
|
+
/** New playlist comment. */
|
|
2234
|
+
comment?: string;
|
|
2235
|
+
/** A song id to add to the playlist. */
|
|
2236
|
+
songIdToAdd?: string;
|
|
2237
|
+
/** A track index to remove from the playlist. */
|
|
2238
|
+
songIndexToRemove?: number;
|
|
2239
|
+
}
|
|
2240
|
+
export interface UpdatePlaylistOutput {
|
|
2241
|
+
}
|
|
1926
2242
|
/**
|
|
1927
2243
|
* Map of every XRPC method (NSID) to the type of its response body.
|
|
1928
2244
|
* Endpoints with no output map to `void`. Used by the SDK to type method
|
|
@@ -1950,7 +2266,7 @@ export interface Endpoints {
|
|
|
1950
2266
|
"app.rocksky.artist.getArtistAlbums": GetArtistAlbumsOutput;
|
|
1951
2267
|
"app.rocksky.artist.getArtistListeners": GetArtistListenersOutput;
|
|
1952
2268
|
"app.rocksky.artist.getArtistRecentListeners": GetArtistRecentListenersOutput;
|
|
1953
|
-
"app.rocksky.artist.getArtists":
|
|
2269
|
+
"app.rocksky.artist.getArtists": ArtistGetArtistsOutput;
|
|
1954
2270
|
"app.rocksky.artist.getArtistTracks": GetArtistTracksOutput;
|
|
1955
2271
|
"app.rocksky.charts.getScrobblesChart": ChartsView;
|
|
1956
2272
|
"app.rocksky.charts.getTopArtists": GetTopArtistsOutput;
|
|
@@ -1977,6 +2293,47 @@ export interface Endpoints {
|
|
|
1977
2293
|
"app.rocksky.graph.getFollows": GetFollowsOutput;
|
|
1978
2294
|
"app.rocksky.graph.getKnownFollowers": GetKnownFollowersOutput;
|
|
1979
2295
|
"app.rocksky.graph.unfollowAccount": UnfollowAccountOutput;
|
|
2296
|
+
"app.rocksky.library.createPlaylist": LibraryCreatePlaylistOutput;
|
|
2297
|
+
"app.rocksky.library.deleteAlbum": DeleteAlbumOutput;
|
|
2298
|
+
"app.rocksky.library.deletePlaylist": DeletePlaylistOutput;
|
|
2299
|
+
"app.rocksky.library.deleteSong": DeleteSongOutput;
|
|
2300
|
+
"app.rocksky.library.getAlbum": LibraryGetAlbumOutput;
|
|
2301
|
+
"app.rocksky.library.getAlbumInfo": GetAlbumInfoOutput;
|
|
2302
|
+
"app.rocksky.library.getAlbumList": GetAlbumListOutput;
|
|
2303
|
+
"app.rocksky.library.getArtist": LibraryGetArtistOutput;
|
|
2304
|
+
"app.rocksky.library.getArtistInfo": GetArtistInfoOutput;
|
|
2305
|
+
"app.rocksky.library.getArtists": LibraryGetArtistsOutput;
|
|
2306
|
+
"app.rocksky.library.getCoverArtUrl": GetCoverArtUrlOutput;
|
|
2307
|
+
"app.rocksky.library.getDownloadUrl": GetDownloadUrlOutput;
|
|
2308
|
+
"app.rocksky.library.getGenres": GetGenresOutput;
|
|
2309
|
+
"app.rocksky.library.getIndexes": GetIndexesOutput;
|
|
2310
|
+
"app.rocksky.library.getInternetRadioStations": GetInternetRadioStationsOutput;
|
|
2311
|
+
"app.rocksky.library.getLicense": GetLicenseOutput;
|
|
2312
|
+
"app.rocksky.library.getLyrics": GetLyricsOutput;
|
|
2313
|
+
"app.rocksky.library.getMusicDirectory": GetMusicDirectoryOutput;
|
|
2314
|
+
"app.rocksky.library.getMusicFolders": GetMusicFoldersOutput;
|
|
2315
|
+
"app.rocksky.library.getNowPlaying": GetNowPlayingOutput;
|
|
2316
|
+
"app.rocksky.library.getPlaylist": LibraryGetPlaylistOutput;
|
|
2317
|
+
"app.rocksky.library.getPlaylists": LibraryGetPlaylistsOutput;
|
|
2318
|
+
"app.rocksky.library.getPlayQueue": GetPlayQueueOutput;
|
|
2319
|
+
"app.rocksky.library.getRandomSongs": GetRandomSongsOutput;
|
|
2320
|
+
"app.rocksky.library.getScanStatus": GetScanStatusOutput;
|
|
2321
|
+
"app.rocksky.library.getSimilarSongs": GetSimilarSongsOutput;
|
|
2322
|
+
"app.rocksky.library.getSong": LibraryGetSongOutput;
|
|
2323
|
+
"app.rocksky.library.getSongsByGenre": GetSongsByGenreOutput;
|
|
2324
|
+
"app.rocksky.library.getStarred": GetStarredOutput;
|
|
2325
|
+
"app.rocksky.library.getStreamUrl": GetStreamUrlOutput;
|
|
2326
|
+
"app.rocksky.library.getTopSongs": GetTopSongsOutput;
|
|
2327
|
+
"app.rocksky.library.getUser": GetUserOutput;
|
|
2328
|
+
"app.rocksky.library.ping": PingOutput;
|
|
2329
|
+
"app.rocksky.library.savePlayQueue": SavePlayQueueOutput;
|
|
2330
|
+
"app.rocksky.library.scrobble": ScrobbleOutput;
|
|
2331
|
+
"app.rocksky.library.search": LibrarySearchOutput;
|
|
2332
|
+
"app.rocksky.library.star": StarOutput;
|
|
2333
|
+
"app.rocksky.library.startScan": StartScanOutput;
|
|
2334
|
+
"app.rocksky.library.unstar": UnstarOutput;
|
|
2335
|
+
"app.rocksky.library.updateNowPlaying": UpdateNowPlayingOutput;
|
|
2336
|
+
"app.rocksky.library.updatePlaylist": UpdatePlaylistOutput;
|
|
1980
2337
|
"app.rocksky.like.dislikeShout": ShoutView;
|
|
1981
2338
|
"app.rocksky.like.dislikeSong": SongViewDetailed;
|
|
1982
2339
|
"app.rocksky.like.likeShout": ShoutView;
|
|
@@ -1996,7 +2353,7 @@ export interface Endpoints {
|
|
|
1996
2353
|
"app.rocksky.player.seek": void;
|
|
1997
2354
|
"app.rocksky.playlist.createPlaylist": void;
|
|
1998
2355
|
"app.rocksky.playlist.getPlaylist": PlaylistViewDetailed;
|
|
1999
|
-
"app.rocksky.playlist.getPlaylists":
|
|
2356
|
+
"app.rocksky.playlist.getPlaylists": PlaylistGetPlaylistsOutput;
|
|
2000
2357
|
"app.rocksky.playlist.insertDirectory": void;
|
|
2001
2358
|
"app.rocksky.playlist.insertFiles": void;
|
|
2002
2359
|
"app.rocksky.playlist.removePlaylist": void;
|