@tidal-music/api 0.11.0 → 0.13.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/dist/index.d.ts +289 -15
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -7,20 +7,24 @@ export declare interface components {
|
|
|
7
7
|
data: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data"];
|
|
8
8
|
};
|
|
9
9
|
AcceptedTermsCreateOperation_Payload_Data: {
|
|
10
|
-
|
|
10
|
+
relationships: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data_Relationships"];
|
|
11
11
|
/** @enum {string} */
|
|
12
12
|
type: "acceptedTerms";
|
|
13
13
|
};
|
|
14
|
-
|
|
14
|
+
AcceptedTermsCreateOperation_Payload_Data_Relationships: {
|
|
15
|
+
terms: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms"];
|
|
16
|
+
};
|
|
17
|
+
AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms: {
|
|
18
|
+
data: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms_Data"];
|
|
19
|
+
};
|
|
20
|
+
AcceptedTermsCreateOperation_Payload_Data_Relationships_Terms_Data: {
|
|
21
|
+
id: string;
|
|
15
22
|
/** @enum {string} */
|
|
16
|
-
|
|
23
|
+
type: "terms";
|
|
17
24
|
};
|
|
18
25
|
AcceptedTerms_Attributes: {
|
|
19
26
|
/** Format: date-time */
|
|
20
27
|
createdAt: string;
|
|
21
|
-
/** @enum {string} */
|
|
22
|
-
termsType: "DEVELOPER";
|
|
23
|
-
termsVersion: string;
|
|
24
28
|
};
|
|
25
29
|
AcceptedTerms_Multi_Relationship_Data_Document: {
|
|
26
30
|
data?: components["schemas"]["Resource_Identifier"][];
|
|
@@ -34,6 +38,7 @@ export declare interface components {
|
|
|
34
38
|
};
|
|
35
39
|
AcceptedTerms_Relationships: {
|
|
36
40
|
owners?: components["schemas"]["Multi_Relationship_Data_Document"];
|
|
41
|
+
terms?: components["schemas"]["Single_Relationship_Data_Document"];
|
|
37
42
|
};
|
|
38
43
|
AcceptedTerms_Resource_Object: {
|
|
39
44
|
attributes?: components["schemas"]["AcceptedTerms_Attributes"];
|
|
@@ -49,6 +54,11 @@ export declare interface components {
|
|
|
49
54
|
*/
|
|
50
55
|
type: "acceptedTerms";
|
|
51
56
|
};
|
|
57
|
+
AcceptedTerms_Single_Relationship_Data_Document: {
|
|
58
|
+
data?: components["schemas"]["Resource_Identifier"];
|
|
59
|
+
included?: components["schemas"]["Included"];
|
|
60
|
+
links: components["schemas"]["Links"];
|
|
61
|
+
};
|
|
52
62
|
AcceptedTerms_Single_Resource_Data_Document: {
|
|
53
63
|
data: components["schemas"]["AcceptedTerms_Resource_Object"];
|
|
54
64
|
included?: components["schemas"]["Included"];
|
|
@@ -355,6 +365,7 @@ export declare interface components {
|
|
|
355
365
|
owners?: components["schemas"]["Multi_Relationship_Data_Document"];
|
|
356
366
|
priceConfig?: components["schemas"]["Single_Relationship_Data_Document"];
|
|
357
367
|
providers?: components["schemas"]["Multi_Relationship_Data_Document"];
|
|
368
|
+
replacement?: components["schemas"]["Single_Relationship_Data_Document"];
|
|
358
369
|
similarAlbums?: components["schemas"]["Multi_Relationship_Data_Document"];
|
|
359
370
|
suggestedCoverArts?: components["schemas"]["Albums_SuggestedCoverArts_Multi_Relationship_Data_Document"];
|
|
360
371
|
usageRules?: components["schemas"]["Single_Relationship_Data_Document"];
|
|
@@ -1475,6 +1486,7 @@ export declare interface components {
|
|
|
1475
1486
|
certificateUrl?: string;
|
|
1476
1487
|
/** @enum {string} */
|
|
1477
1488
|
drmSystem?: "FAIRPLAY" | "WIDEVINE";
|
|
1489
|
+
initData?: string[];
|
|
1478
1490
|
licenseUrl?: string;
|
|
1479
1491
|
};
|
|
1480
1492
|
DspSharingLinks_Attributes: {
|
|
@@ -1532,13 +1544,13 @@ export declare interface components {
|
|
|
1532
1544
|
* @example HORIZONTAL_LIST
|
|
1533
1545
|
* @enum {string}
|
|
1534
1546
|
*/
|
|
1535
|
-
moduleType: "ARTIST_LIST" | "COMPACT_GRID_CARD" | "COMPACT_HORIZONTAL_LIST" | "COMPACT_HORIZONTAL_LIST_WITH_CONTEXT" | "FEATURED_CARD" | "GRID_CARD" | "GRID_CARD_WITH_CONTEXT" | "GRID_HIGHLIGHT_CARD" | "HORIZONTAL_LIST" | "HORIZONTAL_LIST_WITH_CONTEXT" | "SHORTCUT_LIST" | "TRACK_LIST" | "VERTICAL_LIST_CARD" | "TEXT_CARD" | "LINKS_LIST" | "PUBLIC_PLAYLIST_LIST";
|
|
1547
|
+
moduleType: "ARTIST_LIST" | "COMPACT_GRID_CARD" | "COMPACT_HORIZONTAL_LIST" | "COMPACT_HORIZONTAL_LIST_WITH_CONTEXT" | "FEATURED_CARD" | "GRID_CARD" | "GRID_CARD_WITH_CONTEXT" | "GRID_HIGHLIGHT_CARD" | "ANNIVERSARY_CARD" | "ARTIST_BIRTHDAY_CARD" | "ARTIST_MEMORIAM_CARD" | "ARTIST_TRACK_CREDITS_CARD" | "PILL_LIST" | "VERTICAL_LIST" | "HORIZONTAL_LIST" | "HORIZONTAL_LIST_WITH_CONTEXT" | "SHORTCUT_LIST" | "TRACK_LIST" | "VERTICAL_LIST_CARD" | "TEXT_CARD" | "LINKS_LIST" | "PUBLIC_PLAYLIST_LIST";
|
|
1536
1548
|
/**
|
|
1537
1549
|
* @description Type of source represented by the module
|
|
1538
1550
|
* @example SHORTCUTS
|
|
1539
1551
|
* @enum {string}
|
|
1540
1552
|
*/
|
|
1541
|
-
sourceType: "ALBUM_RECOMMENDATIONS" | "BECAUSE_YOU_LISTENED_TO_ALBUM" | "BECAUSE_YOU_ADDED_ALBUM" | "BECAUSE_YOU_ADDED_ARTIST" | "CONTINUE_LISTEN_TO" | "DAILY_MIXES" | "FORGOTTEN_FAVORITES" | "GENRE_MIXES" | "HISTORY_MIXES" | "LOCAL_PLAYLISTS" | "MY_PLAYLISTS" | "NEW_ALBUM_SUGGESTIONS" | "NEW_TRACK_SUGGESTIONS" | "NEW_ALBUMS" | "NEW_TRACKS" | "POPULAR_PLAYLISTS" | "RECENTLY_UPDATED_FAVORITED_PLAYLIST" | "RECOMMENDED_USERS_PLAYLISTS" | "SUGGESTED_ESSENTIAL_PLAYLISTS" | "SUGGESTED_RADIOS_MIXES" | "WELCOME_MIX" | "YOUR_FAVORITE_ARTISTS" | "UPLOADS_FOR_YOU" | "LATEST_SPOTLIGHTED_TRACKS" | "SHORTCUTS" | "ARTIST_TOP_TRACKS" | "ARTIST_SPOTLIGHTED_TRACKS" | "ARTIST_ALBUMS" | "ARTIST_TOP_SINGLES" | "ARTIST_COMPILATIONS" | "ARTIST_LIVE_ALBUMS" | "ARTIST_APPEARS_ON" | "ARTIST_PLAYLIST" | "ARTIST_PUBLIC_PLAYLIST" | "ARTIST_SIMILAR_ARTISTS" | "ARTIST_TRACK_UPLOADS" | "ARTIST_LINKS" | "ARTIST_VIDEOS" | "ARTIST_CREDITS" | "ALBUM_ITEMS" | "ALBUM_ANNIVERSARY" | "ARTIST_BIRTHDAY" | "ARTIST_MEMORIAM" | "DJ_TOOLS" | "DJ_ARTIST_CURATED" | "THE_HITS" | "FROM_OUR_EDITORS" | "TOP_PLAYLISTS" | "FEATURED_TOP_TRACKS" | "FEATURED_TOP_ALBUMS" | "TOP_ARTISTS_ESSENTIALS" | "FEATURED_RECOMMENDED_PLAYLISTS" | "HOME_3_FEATURED_PLAYLISTS" | "HOME_3_FEATURED_UPLOAD_TRACKS" | "HOME_3_FEATURED_ALBUMS" | "POPULAR_ALBUMS" | "POPULAR_ARTISTS" | "POPULAR_MIXES" | "FEATURED_RECOMMENDED_TRACKS" | "FEATURED_RECOMMENDED_ALBUMS" | "FEATURED_RECOMMENDED_CLASSIC_ALBUMS" | "BACK_TO_SCHOOL_MUSIC_101" | "BACK_TO_SCHOOL_GENRES_FOR_BEGINNERS" | "HEADLINERS_2026" | "HOME_3_0_GENERIC_PLAYLISTS_1" | "HOME_3_0_GENERIC_PLAYLISTS_2" | "HOME_3_0_GENERIC_ALBUMS_1" | "HOME_3_0_GENERIC_TRACKS_1" | "HOME_3_0_GENERIC_ARTISTS_1" | "HOME_3_0_GENERIC_VIDEOS_1" | "BASED_ON_YOUR_INTERESTS_1" | "BASED_ON_YOUR_INTERESTS_2" | "UPLOAD_PAGE_SPOTLIGHTED_PLAYLISTS" | "UPLOAD_PAGE_PAYGATED_ALBUMS" | "UPLOAD_PAGE_ALBUMS" | "UNKNOWN";
|
|
1553
|
+
sourceType: "ALBUM_RECOMMENDATIONS" | "BECAUSE_YOU_LISTENED_TO_ALBUM" | "BECAUSE_YOU_ADDED_ALBUM" | "BECAUSE_YOU_ADDED_ARTIST" | "CONTINUE_LISTEN_TO" | "DAILY_MIXES" | "FORGOTTEN_FAVORITES" | "GENRE_MIXES" | "HISTORY_MIXES" | "LOCAL_PLAYLISTS" | "MY_PLAYLISTS" | "NEW_ALBUM_SUGGESTIONS" | "NEW_TRACK_SUGGESTIONS" | "NEW_ALBUMS" | "NEW_TRACKS" | "POPULAR_PLAYLISTS" | "RECENTLY_UPDATED_FAVORITED_PLAYLIST" | "RECOMMENDED_USERS_PLAYLISTS" | "SUGGESTED_ESSENTIAL_PLAYLISTS" | "SUGGESTED_RADIOS_MIXES" | "WELCOME_MIX" | "YOUR_FAVORITE_ARTISTS" | "UPLOADS_FOR_YOU" | "LATEST_SPOTLIGHTED_TRACKS" | "SHORTCUTS" | "ARTIST_TOP_TRACKS" | "ARTIST_SPOTLIGHTED_TRACKS" | "ARTIST_ALBUMS" | "ARTIST_TOP_SINGLES" | "ARTIST_COMPILATIONS" | "ARTIST_LIVE_ALBUMS" | "ARTIST_APPEARS_ON" | "ARTIST_PLAYLIST" | "ARTIST_PUBLIC_PLAYLIST" | "ARTIST_SIMILAR_ARTISTS" | "ARTIST_TRACK_UPLOADS" | "ARTIST_LINKS" | "ARTIST_VIDEOS" | "ARTIST_CREDITS" | "ALBUM_ITEMS" | "ALBUM_ANNIVERSARY" | "ARTIST_BIRTHDAY" | "ARTIST_MEMORIAM" | "DJ_TOOLS" | "DJ_ARTIST_CURATED" | "THE_HITS" | "FROM_OUR_EDITORS" | "TOP_PLAYLISTS" | "FEATURED_TOP_TRACKS" | "FEATURED_TOP_ALBUMS" | "TOP_ARTISTS_ESSENTIALS" | "FEATURED_RECOMMENDED_PLAYLISTS" | "HOME_3_FEATURED_PLAYLISTS" | "HOME_3_FEATURED_UPLOAD_TRACKS" | "HOME_3_FEATURED_ALBUMS" | "POPULAR_ALBUMS" | "POPULAR_ARTISTS" | "POPULAR_MIXES" | "FEATURED_RECOMMENDED_TRACKS" | "FEATURED_RECOMMENDED_ALBUMS" | "FEATURED_RECOMMENDED_CLASSIC_ALBUMS" | "BACK_TO_SCHOOL_MUSIC_101" | "BACK_TO_SCHOOL_GENRES_FOR_BEGINNERS" | "HEADLINERS_2026" | "HOME_3_0_GENERIC_PLAYLISTS_1" | "HOME_3_0_GENERIC_PLAYLISTS_2" | "HOME_3_0_GENERIC_ALBUMS_1" | "HOME_3_0_GENERIC_TRACKS_1" | "HOME_3_0_GENERIC_ARTISTS_1" | "HOME_3_0_GENERIC_VIDEOS_1" | "STAFF_PICKS_PAGE_ALBUMS_WE_LOVE" | "STAFF_PICKS_PAGE_EXPLORE" | "STAFF_PICKS_PAGE_FAVORITE_SONGS" | "STAFF_PICKS_PAGE_RECENTLY_UPDATED_PLAYLISTS" | "STAFF_PICKS_PAGE_TIDAL_NEWS_MAGAZINE" | "STAFF_PICKS_PAGE_WHAT_LISTENING_TO" | "BASED_ON_YOUR_INTERESTS_1" | "BASED_ON_YOUR_INTERESTS_2" | "UPLOAD_PAGE_SPOTLIGHTED_PLAYLISTS" | "UPLOAD_PAGE_PAYGATED_ALBUMS" | "UPLOAD_PAGE_ALBUMS" | "TOP_UPLOADERS" | "UPLOAD_PAGE_ARTISTS" | "UPLOAD_PAGE_FEATURED_MAGAZINE" | "EXPLORE_DECADES" | "EXPLORE_GENRES" | "EXPLORE_MOODS" | "UNKNOWN";
|
|
1542
1554
|
/**
|
|
1543
1555
|
* @description Subtitle of the module
|
|
1544
1556
|
* @example Short description of this module
|
|
@@ -1764,7 +1776,7 @@ export declare interface components {
|
|
|
1764
1776
|
status: string;
|
|
1765
1777
|
}[];
|
|
1766
1778
|
};
|
|
1767
|
-
Included: (components["schemas"]["AcceptedTerms_Resource_Object"] | components["schemas"]["AlbumStatistics_Resource_Object"] | components["schemas"]["Albums_Resource_Object"] | components["schemas"]["Appreciations_Resource_Object"] | components["schemas"]["ArtistBiographies_Resource_Object"] | components["schemas"]["ArtistClaims_Resource_Object"] | components["schemas"]["ArtistRoles_Resource_Object"] | components["schemas"]["Artists_Resource_Object"] | components["schemas"]["Artworks_Resource_Object"] | components["schemas"]["Clients_Resource_Object"] | components["schemas"]["Comments_Resource_Object"] | components["schemas"]["ContentClaims_Resource_Object"] | components["schemas"]["Credits_Resource_Object"] | components["schemas"]["Downloads_Resource_Object"] | components["schemas"]["DspSharingLinks_Resource_Object"] | components["schemas"]["DynamicModules_Resource_Object"] | components["schemas"]["DynamicPages_Resource_Object"] | components["schemas"]["Genres_Resource_Object"] | components["schemas"]["Installations_Resource_Object"] | components["schemas"]["Lyrics_Resource_Object"] | components["schemas"]["ManualArtistClaims_Resource_Object"] | components["schemas"]["OfflineTasks_Resource_Object"] | components["schemas"]["PlayQueues_Resource_Object"] | components["schemas"]["Playlists_Resource_Object"] | components["schemas"]["PriceConfigurations_Resource_Object"] | components["schemas"]["Providers_Resource_Object"] | components["schemas"]["Reactions_Resource_Object"] | components["schemas"]["SavedShares_Resource_Object"] | components["schemas"]["SearchResults_Resource_Object"] | components["schemas"]["SearchSuggestions_Resource_Object"] | components["schemas"]["Shares_Resource_Object"] | components["schemas"]["StripeConnections_Resource_Object"] | components["schemas"]["StripeDashboardLinks_Resource_Object"] | components["schemas"]["TrackFiles_Resource_Object"] | components["schemas"]["TrackManifests_Resource_Object"] | components["schemas"]["TrackSourceFiles_Resource_Object"] | components["schemas"]["TrackStatistics_Resource_Object"] | components["schemas"]["Tracks_Resource_Object"] | components["schemas"]["TracksMetadataStatus_Resource_Object"] | components["schemas"]["UsageRules_Resource_Object"] | components["schemas"]["UserCollectionAlbums_Resource_Object"] | components["schemas"]["UserCollectionArtists_Resource_Object"] | components["schemas"]["UserCollectionFolders_Resource_Object"] | components["schemas"]["UserCollectionPlaylists_Resource_Object"] | components["schemas"]["UserCollectionTracks_Resource_Object"] | components["schemas"]["UserCollectionVideos_Resource_Object"] | components["schemas"]["UserCollections_Resource_Object"] | components["schemas"]["UserDataExportRequests_Resource_Object"] | components["schemas"]["UserRecommendations_Resource_Object"] | components["schemas"]["UserReports_Resource_Object"] | components["schemas"]["Users_Resource_Object"] | components["schemas"]["VideoManifests_Resource_Object"] | components["schemas"]["Videos_Resource_Object"])[];
|
|
1779
|
+
Included: (components["schemas"]["AcceptedTerms_Resource_Object"] | components["schemas"]["AlbumStatistics_Resource_Object"] | components["schemas"]["Albums_Resource_Object"] | components["schemas"]["Appreciations_Resource_Object"] | components["schemas"]["ArtistBiographies_Resource_Object"] | components["schemas"]["ArtistClaims_Resource_Object"] | components["schemas"]["ArtistRoles_Resource_Object"] | components["schemas"]["Artists_Resource_Object"] | components["schemas"]["Artworks_Resource_Object"] | components["schemas"]["Clients_Resource_Object"] | components["schemas"]["Comments_Resource_Object"] | components["schemas"]["ContentClaims_Resource_Object"] | components["schemas"]["Credits_Resource_Object"] | components["schemas"]["Downloads_Resource_Object"] | components["schemas"]["DspSharingLinks_Resource_Object"] | components["schemas"]["DynamicModules_Resource_Object"] | components["schemas"]["DynamicPages_Resource_Object"] | components["schemas"]["Genres_Resource_Object"] | components["schemas"]["Installations_Resource_Object"] | components["schemas"]["Lyrics_Resource_Object"] | components["schemas"]["ManualArtistClaims_Resource_Object"] | components["schemas"]["OfflineTasks_Resource_Object"] | components["schemas"]["PlayQueues_Resource_Object"] | components["schemas"]["Playlists_Resource_Object"] | components["schemas"]["PriceConfigurations_Resource_Object"] | components["schemas"]["Providers_Resource_Object"] | components["schemas"]["Reactions_Resource_Object"] | components["schemas"]["SavedShares_Resource_Object"] | components["schemas"]["SearchResults_Resource_Object"] | components["schemas"]["SearchSuggestions_Resource_Object"] | components["schemas"]["Shares_Resource_Object"] | components["schemas"]["StripeConnections_Resource_Object"] | components["schemas"]["StripeDashboardLinks_Resource_Object"] | components["schemas"]["Terms_Resource_Object"] | components["schemas"]["TrackFiles_Resource_Object"] | components["schemas"]["TrackManifests_Resource_Object"] | components["schemas"]["TrackSourceFiles_Resource_Object"] | components["schemas"]["TrackStatistics_Resource_Object"] | components["schemas"]["Tracks_Resource_Object"] | components["schemas"]["TracksMetadataStatus_Resource_Object"] | components["schemas"]["UsageRules_Resource_Object"] | components["schemas"]["UserCollectionAlbums_Resource_Object"] | components["schemas"]["UserCollectionArtists_Resource_Object"] | components["schemas"]["UserCollectionFolders_Resource_Object"] | components["schemas"]["UserCollectionPlaylists_Resource_Object"] | components["schemas"]["UserCollectionTracks_Resource_Object"] | components["schemas"]["UserCollectionVideos_Resource_Object"] | components["schemas"]["UserCollections_Resource_Object"] | components["schemas"]["UserDataExportRequests_Resource_Object"] | components["schemas"]["UserRecommendations_Resource_Object"] | components["schemas"]["UserReports_Resource_Object"] | components["schemas"]["Users_Resource_Object"] | components["schemas"]["VideoManifests_Resource_Object"] | components["schemas"]["Videos_Resource_Object"])[];
|
|
1768
1780
|
InstallationsCreateOperation_Payload: {
|
|
1769
1781
|
data: components["schemas"]["InstallationsCreateOperation_Payload_Data"];
|
|
1770
1782
|
};
|
|
@@ -3153,6 +3165,36 @@ export declare interface components {
|
|
|
3153
3165
|
included?: components["schemas"]["Included"];
|
|
3154
3166
|
links: components["schemas"]["Links"];
|
|
3155
3167
|
};
|
|
3168
|
+
Terms_Attributes: {
|
|
3169
|
+
contentLink: components["schemas"]["Link_Object"];
|
|
3170
|
+
/** Format: date-time */
|
|
3171
|
+
effectiveAt: string;
|
|
3172
|
+
/** @enum {string} */
|
|
3173
|
+
termsType: "DEVELOPER";
|
|
3174
|
+
};
|
|
3175
|
+
Terms_Multi_Resource_Data_Document: {
|
|
3176
|
+
data: components["schemas"]["Terms_Resource_Object"][];
|
|
3177
|
+
included?: components["schemas"]["Included"];
|
|
3178
|
+
links: components["schemas"]["Links"];
|
|
3179
|
+
};
|
|
3180
|
+
Terms_Resource_Object: {
|
|
3181
|
+
attributes?: components["schemas"]["Terms_Attributes"];
|
|
3182
|
+
/**
|
|
3183
|
+
* @description Resource id
|
|
3184
|
+
* @example 12345
|
|
3185
|
+
*/
|
|
3186
|
+
id: string;
|
|
3187
|
+
/**
|
|
3188
|
+
* @description Resource type (enum property replaced by openapi-typescript)
|
|
3189
|
+
* @enum {string}
|
|
3190
|
+
*/
|
|
3191
|
+
type: "terms";
|
|
3192
|
+
};
|
|
3193
|
+
Terms_Single_Resource_Data_Document: {
|
|
3194
|
+
data: components["schemas"]["Terms_Resource_Object"];
|
|
3195
|
+
included?: components["schemas"]["Included"];
|
|
3196
|
+
links: components["schemas"]["Links"];
|
|
3197
|
+
};
|
|
3156
3198
|
ThirdPartyLyricsProvider: Omit<WithRequired<components["schemas"]["LyricsProvider"], "name">, "source"> & {
|
|
3157
3199
|
commonTrackId: string;
|
|
3158
3200
|
lyricsId: string;
|
|
@@ -5157,16 +5199,16 @@ declare interface paths {
|
|
|
5157
5199
|
parameters: {
|
|
5158
5200
|
query?: {
|
|
5159
5201
|
/**
|
|
5160
|
-
* @description Allows the client to customize which related resources should be returned. Available options: owners
|
|
5202
|
+
* @description Allows the client to customize which related resources should be returned. Available options: owners, terms
|
|
5161
5203
|
* @example owners
|
|
5162
5204
|
*/
|
|
5163
5205
|
include?: string[];
|
|
5164
|
-
/** @description Filter by latestVersion */
|
|
5165
|
-
"filter[latestVersion]"?: string[];
|
|
5166
5206
|
/** @description User id. Use `me` for the authenticated user */
|
|
5167
5207
|
"filter[owners.id]"?: string[];
|
|
5208
|
+
/** @description Filter by terms.isLatestVersion */
|
|
5209
|
+
"filter[terms.isLatestVersion]"?: string[];
|
|
5168
5210
|
/** @description One of: DEVELOPER (e.g. `DEVELOPER`) */
|
|
5169
|
-
"filter[termsType]"?: "DEVELOPER"[];
|
|
5211
|
+
"filter[terms.termsType]"?: "DEVELOPER"[];
|
|
5170
5212
|
};
|
|
5171
5213
|
header?: never;
|
|
5172
5214
|
path?: never;
|
|
@@ -5302,6 +5344,65 @@ declare interface paths {
|
|
|
5302
5344
|
patch?: never;
|
|
5303
5345
|
trace?: never;
|
|
5304
5346
|
};
|
|
5347
|
+
"/acceptedTerms/{id}/relationships/terms": {
|
|
5348
|
+
parameters: {
|
|
5349
|
+
query?: never;
|
|
5350
|
+
header?: never;
|
|
5351
|
+
path?: never;
|
|
5352
|
+
cookie?: never;
|
|
5353
|
+
};
|
|
5354
|
+
/**
|
|
5355
|
+
* Get terms relationship ("to-one").
|
|
5356
|
+
* @description Retrieves terms relationship.
|
|
5357
|
+
*/
|
|
5358
|
+
get: {
|
|
5359
|
+
parameters: {
|
|
5360
|
+
query?: {
|
|
5361
|
+
/**
|
|
5362
|
+
* @description Allows the client to customize which related resources should be returned. Available options: terms
|
|
5363
|
+
* @example terms
|
|
5364
|
+
*/
|
|
5365
|
+
include?: string[];
|
|
5366
|
+
};
|
|
5367
|
+
header?: never;
|
|
5368
|
+
path: {
|
|
5369
|
+
/**
|
|
5370
|
+
* @description Accepted terms id
|
|
5371
|
+
* @example a468bee88def
|
|
5372
|
+
*/
|
|
5373
|
+
id: string;
|
|
5374
|
+
};
|
|
5375
|
+
cookie?: never;
|
|
5376
|
+
};
|
|
5377
|
+
requestBody?: never;
|
|
5378
|
+
responses: {
|
|
5379
|
+
/** @description Successful response */
|
|
5380
|
+
200: {
|
|
5381
|
+
headers: {
|
|
5382
|
+
[name: string]: unknown;
|
|
5383
|
+
};
|
|
5384
|
+
content: {
|
|
5385
|
+
"application/vnd.api+json": components["schemas"]["AcceptedTerms_Single_Relationship_Data_Document"];
|
|
5386
|
+
};
|
|
5387
|
+
};
|
|
5388
|
+
400: components["responses"]["Default400Response"];
|
|
5389
|
+
404: components["responses"]["Default404Response"];
|
|
5390
|
+
405: components["responses"]["Default405Response"];
|
|
5391
|
+
406: components["responses"]["Default406Response"];
|
|
5392
|
+
415: components["responses"]["Default415Response"];
|
|
5393
|
+
429: components["responses"]["Default429Response"];
|
|
5394
|
+
500: components["responses"]["Default500Response"];
|
|
5395
|
+
503: components["responses"]["Default503Response"];
|
|
5396
|
+
};
|
|
5397
|
+
};
|
|
5398
|
+
put?: never;
|
|
5399
|
+
post?: never;
|
|
5400
|
+
delete?: never;
|
|
5401
|
+
options?: never;
|
|
5402
|
+
head?: never;
|
|
5403
|
+
patch?: never;
|
|
5404
|
+
trace?: never;
|
|
5405
|
+
};
|
|
5305
5406
|
"/albumStatistics": {
|
|
5306
5407
|
parameters: {
|
|
5307
5408
|
query?: never;
|
|
@@ -5501,7 +5602,7 @@ declare interface paths {
|
|
|
5501
5602
|
*/
|
|
5502
5603
|
countryCode?: string;
|
|
5503
5604
|
/**
|
|
5504
|
-
* @description Allows the client to customize which related resources should be returned. Available options: albumStatistics, artists, coverArt, genres, items, owners, priceConfig, providers, similarAlbums, suggestedCoverArts, usageRules
|
|
5605
|
+
* @description Allows the client to customize which related resources should be returned. Available options: albumStatistics, artists, coverArt, genres, items, owners, priceConfig, providers, replacement, similarAlbums, suggestedCoverArts, usageRules
|
|
5505
5606
|
* @example albumStatistics
|
|
5506
5607
|
*/
|
|
5507
5608
|
include?: string[];
|
|
@@ -5607,7 +5708,7 @@ declare interface paths {
|
|
|
5607
5708
|
*/
|
|
5608
5709
|
countryCode?: string;
|
|
5609
5710
|
/**
|
|
5610
|
-
* @description Allows the client to customize which related resources should be returned. Available options: albumStatistics, artists, coverArt, genres, items, owners, priceConfig, providers, similarAlbums, suggestedCoverArts, usageRules
|
|
5711
|
+
* @description Allows the client to customize which related resources should be returned. Available options: albumStatistics, artists, coverArt, genres, items, owners, priceConfig, providers, replacement, similarAlbums, suggestedCoverArts, usageRules
|
|
5611
5712
|
* @example albumStatistics
|
|
5612
5713
|
*/
|
|
5613
5714
|
include?: string[];
|
|
@@ -6327,6 +6428,72 @@ declare interface paths {
|
|
|
6327
6428
|
patch?: never;
|
|
6328
6429
|
trace?: never;
|
|
6329
6430
|
};
|
|
6431
|
+
"/albums/{id}/relationships/replacement": {
|
|
6432
|
+
parameters: {
|
|
6433
|
+
query?: never;
|
|
6434
|
+
header?: never;
|
|
6435
|
+
path?: never;
|
|
6436
|
+
cookie?: never;
|
|
6437
|
+
};
|
|
6438
|
+
/**
|
|
6439
|
+
* Get replacement relationship ("to-one").
|
|
6440
|
+
* @description Retrieves replacement relationship.
|
|
6441
|
+
*/
|
|
6442
|
+
get: {
|
|
6443
|
+
parameters: {
|
|
6444
|
+
query?: {
|
|
6445
|
+
/**
|
|
6446
|
+
* @description ISO 3166-1 alpha-2 country code
|
|
6447
|
+
* @example US
|
|
6448
|
+
*/
|
|
6449
|
+
countryCode?: string;
|
|
6450
|
+
/**
|
|
6451
|
+
* @description Allows the client to customize which related resources should be returned. Available options: replacement
|
|
6452
|
+
* @example replacement
|
|
6453
|
+
*/
|
|
6454
|
+
include?: string[];
|
|
6455
|
+
/** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
|
|
6456
|
+
shareCode?: string;
|
|
6457
|
+
};
|
|
6458
|
+
header?: never;
|
|
6459
|
+
path: {
|
|
6460
|
+
/**
|
|
6461
|
+
* @description Album id
|
|
6462
|
+
* @example 251380836
|
|
6463
|
+
*/
|
|
6464
|
+
id: string;
|
|
6465
|
+
};
|
|
6466
|
+
cookie?: never;
|
|
6467
|
+
};
|
|
6468
|
+
requestBody?: never;
|
|
6469
|
+
responses: {
|
|
6470
|
+
/** @description Successful response */
|
|
6471
|
+
200: {
|
|
6472
|
+
headers: {
|
|
6473
|
+
[name: string]: unknown;
|
|
6474
|
+
};
|
|
6475
|
+
content: {
|
|
6476
|
+
"application/vnd.api+json": components["schemas"]["Albums_Single_Relationship_Data_Document"];
|
|
6477
|
+
};
|
|
6478
|
+
};
|
|
6479
|
+
400: components["responses"]["Default400Response"];
|
|
6480
|
+
404: components["responses"]["Default404Response"];
|
|
6481
|
+
405: components["responses"]["Default405Response"];
|
|
6482
|
+
406: components["responses"]["Default406Response"];
|
|
6483
|
+
415: components["responses"]["Default415Response"];
|
|
6484
|
+
429: components["responses"]["Default429Response"];
|
|
6485
|
+
500: components["responses"]["Default500Response"];
|
|
6486
|
+
503: components["responses"]["Default503Response"];
|
|
6487
|
+
};
|
|
6488
|
+
};
|
|
6489
|
+
put?: never;
|
|
6490
|
+
post?: never;
|
|
6491
|
+
delete?: never;
|
|
6492
|
+
options?: never;
|
|
6493
|
+
head?: never;
|
|
6494
|
+
patch?: never;
|
|
6495
|
+
trace?: never;
|
|
6496
|
+
};
|
|
6330
6497
|
"/albums/{id}/relationships/similarAlbums": {
|
|
6331
6498
|
parameters: {
|
|
6332
6499
|
query?: never;
|
|
@@ -15115,6 +15282,113 @@ declare interface paths {
|
|
|
15115
15282
|
patch?: never;
|
|
15116
15283
|
trace?: never;
|
|
15117
15284
|
};
|
|
15285
|
+
"/terms": {
|
|
15286
|
+
parameters: {
|
|
15287
|
+
query?: never;
|
|
15288
|
+
header?: never;
|
|
15289
|
+
path?: never;
|
|
15290
|
+
cookie?: never;
|
|
15291
|
+
};
|
|
15292
|
+
/**
|
|
15293
|
+
* Get multiple terms.
|
|
15294
|
+
* @description Retrieves multiple terms by available filters, or without if applicable.
|
|
15295
|
+
*/
|
|
15296
|
+
get: {
|
|
15297
|
+
parameters: {
|
|
15298
|
+
query?: {
|
|
15299
|
+
/** @description Terms id (e.g. `a468bee88def`) */
|
|
15300
|
+
"filter[id]"?: string[];
|
|
15301
|
+
/** @description Filter by isLatestVersion */
|
|
15302
|
+
"filter[isLatestVersion]"?: string[];
|
|
15303
|
+
/** @description One of: DEVELOPER (e.g. `DEVELOPER`) */
|
|
15304
|
+
"filter[termsType]"?: "DEVELOPER"[];
|
|
15305
|
+
};
|
|
15306
|
+
header?: never;
|
|
15307
|
+
path?: never;
|
|
15308
|
+
cookie?: never;
|
|
15309
|
+
};
|
|
15310
|
+
requestBody?: never;
|
|
15311
|
+
responses: {
|
|
15312
|
+
/** @description Successful response */
|
|
15313
|
+
200: {
|
|
15314
|
+
headers: {
|
|
15315
|
+
[name: string]: unknown;
|
|
15316
|
+
};
|
|
15317
|
+
content: {
|
|
15318
|
+
"application/vnd.api+json": components["schemas"]["Terms_Multi_Resource_Data_Document"];
|
|
15319
|
+
};
|
|
15320
|
+
};
|
|
15321
|
+
400: components["responses"]["Default400Response"];
|
|
15322
|
+
404: components["responses"]["Default404Response"];
|
|
15323
|
+
405: components["responses"]["Default405Response"];
|
|
15324
|
+
406: components["responses"]["Default406Response"];
|
|
15325
|
+
415: components["responses"]["Default415Response"];
|
|
15326
|
+
429: components["responses"]["Default429Response"];
|
|
15327
|
+
500: components["responses"]["Default500Response"];
|
|
15328
|
+
503: components["responses"]["Default503Response"];
|
|
15329
|
+
};
|
|
15330
|
+
};
|
|
15331
|
+
put?: never;
|
|
15332
|
+
post?: never;
|
|
15333
|
+
delete?: never;
|
|
15334
|
+
options?: never;
|
|
15335
|
+
head?: never;
|
|
15336
|
+
patch?: never;
|
|
15337
|
+
trace?: never;
|
|
15338
|
+
};
|
|
15339
|
+
"/terms/{id}": {
|
|
15340
|
+
parameters: {
|
|
15341
|
+
query?: never;
|
|
15342
|
+
header?: never;
|
|
15343
|
+
path?: never;
|
|
15344
|
+
cookie?: never;
|
|
15345
|
+
};
|
|
15346
|
+
/**
|
|
15347
|
+
* Get single term.
|
|
15348
|
+
* @description Retrieves single term by id.
|
|
15349
|
+
*/
|
|
15350
|
+
get: {
|
|
15351
|
+
parameters: {
|
|
15352
|
+
query?: never;
|
|
15353
|
+
header?: never;
|
|
15354
|
+
path: {
|
|
15355
|
+
/**
|
|
15356
|
+
* @description Terms id
|
|
15357
|
+
* @example a468bee88def
|
|
15358
|
+
*/
|
|
15359
|
+
id: string;
|
|
15360
|
+
};
|
|
15361
|
+
cookie?: never;
|
|
15362
|
+
};
|
|
15363
|
+
requestBody?: never;
|
|
15364
|
+
responses: {
|
|
15365
|
+
/** @description Successful response */
|
|
15366
|
+
200: {
|
|
15367
|
+
headers: {
|
|
15368
|
+
[name: string]: unknown;
|
|
15369
|
+
};
|
|
15370
|
+
content: {
|
|
15371
|
+
"application/vnd.api+json": components["schemas"]["Terms_Single_Resource_Data_Document"];
|
|
15372
|
+
};
|
|
15373
|
+
};
|
|
15374
|
+
400: components["responses"]["Default400Response"];
|
|
15375
|
+
404: components["responses"]["Default404Response"];
|
|
15376
|
+
405: components["responses"]["Default405Response"];
|
|
15377
|
+
406: components["responses"]["Default406Response"];
|
|
15378
|
+
415: components["responses"]["Default415Response"];
|
|
15379
|
+
429: components["responses"]["Default429Response"];
|
|
15380
|
+
500: components["responses"]["Default500Response"];
|
|
15381
|
+
503: components["responses"]["Default503Response"];
|
|
15382
|
+
};
|
|
15383
|
+
};
|
|
15384
|
+
put?: never;
|
|
15385
|
+
post?: never;
|
|
15386
|
+
delete?: never;
|
|
15387
|
+
options?: never;
|
|
15388
|
+
head?: never;
|
|
15389
|
+
patch?: never;
|
|
15390
|
+
trace?: never;
|
|
15391
|
+
};
|
|
15118
15392
|
"/trackFiles/{id}": {
|
|
15119
15393
|
parameters: {
|
|
15120
15394
|
query?: never;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tidal-music/api",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.13.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"files": [
|
|
6
6
|
"dist"
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
},
|
|
19
19
|
"dependencies": {
|
|
20
20
|
"openapi-fetch": "0.17.0",
|
|
21
|
-
"@tidal-music/api": "0.
|
|
21
|
+
"@tidal-music/api": "0.13.0"
|
|
22
22
|
},
|
|
23
23
|
"devDependencies": {
|
|
24
24
|
"@vitest/coverage-v8": "4.1.0",
|