@tidal-music/api 0.11.0 → 0.12.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.
Files changed (2) hide show
  1. package/dist/index.d.ts +288 -15
  2. package/package.json +4 -4
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
- attributes: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data_Attributes"];
10
+ relationships: components["schemas"]["AcceptedTermsCreateOperation_Payload_Data_Relationships"];
11
11
  /** @enum {string} */
12
12
  type: "acceptedTerms";
13
13
  };
14
- AcceptedTermsCreateOperation_Payload_Data_Attributes: {
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
- termsType: "DEVELOPER";
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,35 @@ export declare interface components {
3153
3165
  included?: components["schemas"]["Included"];
3154
3166
  links: components["schemas"]["Links"];
3155
3167
  };
3168
+ Terms_Attributes: {
3169
+ contentMarkdown: string;
3170
+ /** @enum {string} */
3171
+ termsType: "DEVELOPER";
3172
+ termsVersion: string;
3173
+ };
3174
+ Terms_Multi_Resource_Data_Document: {
3175
+ data: components["schemas"]["Terms_Resource_Object"][];
3176
+ included?: components["schemas"]["Included"];
3177
+ links: components["schemas"]["Links"];
3178
+ };
3179
+ Terms_Resource_Object: {
3180
+ attributes?: components["schemas"]["Terms_Attributes"];
3181
+ /**
3182
+ * @description Resource id
3183
+ * @example 12345
3184
+ */
3185
+ id: string;
3186
+ /**
3187
+ * @description Resource type (enum property replaced by openapi-typescript)
3188
+ * @enum {string}
3189
+ */
3190
+ type: "terms";
3191
+ };
3192
+ Terms_Single_Resource_Data_Document: {
3193
+ data: components["schemas"]["Terms_Resource_Object"];
3194
+ included?: components["schemas"]["Included"];
3195
+ links: components["schemas"]["Links"];
3196
+ };
3156
3197
  ThirdPartyLyricsProvider: Omit<WithRequired<components["schemas"]["LyricsProvider"], "name">, "source"> & {
3157
3198
  commonTrackId: string;
3158
3199
  lyricsId: string;
@@ -5157,16 +5198,16 @@ declare interface paths {
5157
5198
  parameters: {
5158
5199
  query?: {
5159
5200
  /**
5160
- * @description Allows the client to customize which related resources should be returned. Available options: owners
5201
+ * @description Allows the client to customize which related resources should be returned. Available options: owners, terms
5161
5202
  * @example owners
5162
5203
  */
5163
5204
  include?: string[];
5164
- /** @description Filter by latestVersion */
5165
- "filter[latestVersion]"?: string[];
5166
5205
  /** @description User id. Use `me` for the authenticated user */
5167
5206
  "filter[owners.id]"?: string[];
5207
+ /** @description Filter by terms.isLatestVersion */
5208
+ "filter[terms.isLatestVersion]"?: string[];
5168
5209
  /** @description One of: DEVELOPER (e.g. `DEVELOPER`) */
5169
- "filter[termsType]"?: "DEVELOPER"[];
5210
+ "filter[terms.termsType]"?: "DEVELOPER"[];
5170
5211
  };
5171
5212
  header?: never;
5172
5213
  path?: never;
@@ -5302,6 +5343,65 @@ declare interface paths {
5302
5343
  patch?: never;
5303
5344
  trace?: never;
5304
5345
  };
5346
+ "/acceptedTerms/{id}/relationships/terms": {
5347
+ parameters: {
5348
+ query?: never;
5349
+ header?: never;
5350
+ path?: never;
5351
+ cookie?: never;
5352
+ };
5353
+ /**
5354
+ * Get terms relationship ("to-one").
5355
+ * @description Retrieves terms relationship.
5356
+ */
5357
+ get: {
5358
+ parameters: {
5359
+ query?: {
5360
+ /**
5361
+ * @description Allows the client to customize which related resources should be returned. Available options: terms
5362
+ * @example terms
5363
+ */
5364
+ include?: string[];
5365
+ };
5366
+ header?: never;
5367
+ path: {
5368
+ /**
5369
+ * @description Accepted terms id
5370
+ * @example a468bee88def
5371
+ */
5372
+ id: string;
5373
+ };
5374
+ cookie?: never;
5375
+ };
5376
+ requestBody?: never;
5377
+ responses: {
5378
+ /** @description Successful response */
5379
+ 200: {
5380
+ headers: {
5381
+ [name: string]: unknown;
5382
+ };
5383
+ content: {
5384
+ "application/vnd.api+json": components["schemas"]["AcceptedTerms_Single_Relationship_Data_Document"];
5385
+ };
5386
+ };
5387
+ 400: components["responses"]["Default400Response"];
5388
+ 404: components["responses"]["Default404Response"];
5389
+ 405: components["responses"]["Default405Response"];
5390
+ 406: components["responses"]["Default406Response"];
5391
+ 415: components["responses"]["Default415Response"];
5392
+ 429: components["responses"]["Default429Response"];
5393
+ 500: components["responses"]["Default500Response"];
5394
+ 503: components["responses"]["Default503Response"];
5395
+ };
5396
+ };
5397
+ put?: never;
5398
+ post?: never;
5399
+ delete?: never;
5400
+ options?: never;
5401
+ head?: never;
5402
+ patch?: never;
5403
+ trace?: never;
5404
+ };
5305
5405
  "/albumStatistics": {
5306
5406
  parameters: {
5307
5407
  query?: never;
@@ -5501,7 +5601,7 @@ declare interface paths {
5501
5601
  */
5502
5602
  countryCode?: string;
5503
5603
  /**
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
5604
+ * @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
5605
  * @example albumStatistics
5506
5606
  */
5507
5607
  include?: string[];
@@ -5607,7 +5707,7 @@ declare interface paths {
5607
5707
  */
5608
5708
  countryCode?: string;
5609
5709
  /**
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
5710
+ * @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
5711
  * @example albumStatistics
5612
5712
  */
5613
5713
  include?: string[];
@@ -6327,6 +6427,72 @@ declare interface paths {
6327
6427
  patch?: never;
6328
6428
  trace?: never;
6329
6429
  };
6430
+ "/albums/{id}/relationships/replacement": {
6431
+ parameters: {
6432
+ query?: never;
6433
+ header?: never;
6434
+ path?: never;
6435
+ cookie?: never;
6436
+ };
6437
+ /**
6438
+ * Get replacement relationship ("to-one").
6439
+ * @description Retrieves replacement relationship.
6440
+ */
6441
+ get: {
6442
+ parameters: {
6443
+ query?: {
6444
+ /**
6445
+ * @description ISO 3166-1 alpha-2 country code
6446
+ * @example US
6447
+ */
6448
+ countryCode?: string;
6449
+ /**
6450
+ * @description Allows the client to customize which related resources should be returned. Available options: replacement
6451
+ * @example replacement
6452
+ */
6453
+ include?: string[];
6454
+ /** @description Share code that grants access to UNLISTED resources. When provided, allows non-owners to access resources that would otherwise be restricted. */
6455
+ shareCode?: string;
6456
+ };
6457
+ header?: never;
6458
+ path: {
6459
+ /**
6460
+ * @description Album id
6461
+ * @example 251380836
6462
+ */
6463
+ id: string;
6464
+ };
6465
+ cookie?: never;
6466
+ };
6467
+ requestBody?: never;
6468
+ responses: {
6469
+ /** @description Successful response */
6470
+ 200: {
6471
+ headers: {
6472
+ [name: string]: unknown;
6473
+ };
6474
+ content: {
6475
+ "application/vnd.api+json": components["schemas"]["Albums_Single_Relationship_Data_Document"];
6476
+ };
6477
+ };
6478
+ 400: components["responses"]["Default400Response"];
6479
+ 404: components["responses"]["Default404Response"];
6480
+ 405: components["responses"]["Default405Response"];
6481
+ 406: components["responses"]["Default406Response"];
6482
+ 415: components["responses"]["Default415Response"];
6483
+ 429: components["responses"]["Default429Response"];
6484
+ 500: components["responses"]["Default500Response"];
6485
+ 503: components["responses"]["Default503Response"];
6486
+ };
6487
+ };
6488
+ put?: never;
6489
+ post?: never;
6490
+ delete?: never;
6491
+ options?: never;
6492
+ head?: never;
6493
+ patch?: never;
6494
+ trace?: never;
6495
+ };
6330
6496
  "/albums/{id}/relationships/similarAlbums": {
6331
6497
  parameters: {
6332
6498
  query?: never;
@@ -15115,6 +15281,113 @@ declare interface paths {
15115
15281
  patch?: never;
15116
15282
  trace?: never;
15117
15283
  };
15284
+ "/terms": {
15285
+ parameters: {
15286
+ query?: never;
15287
+ header?: never;
15288
+ path?: never;
15289
+ cookie?: never;
15290
+ };
15291
+ /**
15292
+ * Get multiple terms.
15293
+ * @description Retrieves multiple terms by available filters, or without if applicable.
15294
+ */
15295
+ get: {
15296
+ parameters: {
15297
+ query?: {
15298
+ /** @description Terms id (e.g. `4gfFC5kRVs84pMJpMq3Y8K`) */
15299
+ "filter[id]"?: string[];
15300
+ /** @description Filter by isLatestVersion */
15301
+ "filter[isLatestVersion]"?: string[];
15302
+ /** @description One of: DEVELOPER (e.g. `DEVELOPER`) */
15303
+ "filter[termsType]"?: "DEVELOPER"[];
15304
+ };
15305
+ header?: never;
15306
+ path?: never;
15307
+ cookie?: never;
15308
+ };
15309
+ requestBody?: never;
15310
+ responses: {
15311
+ /** @description Successful response */
15312
+ 200: {
15313
+ headers: {
15314
+ [name: string]: unknown;
15315
+ };
15316
+ content: {
15317
+ "application/vnd.api+json": components["schemas"]["Terms_Multi_Resource_Data_Document"];
15318
+ };
15319
+ };
15320
+ 400: components["responses"]["Default400Response"];
15321
+ 404: components["responses"]["Default404Response"];
15322
+ 405: components["responses"]["Default405Response"];
15323
+ 406: components["responses"]["Default406Response"];
15324
+ 415: components["responses"]["Default415Response"];
15325
+ 429: components["responses"]["Default429Response"];
15326
+ 500: components["responses"]["Default500Response"];
15327
+ 503: components["responses"]["Default503Response"];
15328
+ };
15329
+ };
15330
+ put?: never;
15331
+ post?: never;
15332
+ delete?: never;
15333
+ options?: never;
15334
+ head?: never;
15335
+ patch?: never;
15336
+ trace?: never;
15337
+ };
15338
+ "/terms/{id}": {
15339
+ parameters: {
15340
+ query?: never;
15341
+ header?: never;
15342
+ path?: never;
15343
+ cookie?: never;
15344
+ };
15345
+ /**
15346
+ * Get single term.
15347
+ * @description Retrieves single term by id.
15348
+ */
15349
+ get: {
15350
+ parameters: {
15351
+ query?: never;
15352
+ header?: never;
15353
+ path: {
15354
+ /**
15355
+ * @description Terms id
15356
+ * @example 4gfFC5kRVs84pMJpMq3Y8K
15357
+ */
15358
+ id: string;
15359
+ };
15360
+ cookie?: never;
15361
+ };
15362
+ requestBody?: never;
15363
+ responses: {
15364
+ /** @description Successful response */
15365
+ 200: {
15366
+ headers: {
15367
+ [name: string]: unknown;
15368
+ };
15369
+ content: {
15370
+ "application/vnd.api+json": components["schemas"]["Terms_Single_Resource_Data_Document"];
15371
+ };
15372
+ };
15373
+ 400: components["responses"]["Default400Response"];
15374
+ 404: components["responses"]["Default404Response"];
15375
+ 405: components["responses"]["Default405Response"];
15376
+ 406: components["responses"]["Default406Response"];
15377
+ 415: components["responses"]["Default415Response"];
15378
+ 429: components["responses"]["Default429Response"];
15379
+ 500: components["responses"]["Default500Response"];
15380
+ 503: components["responses"]["Default503Response"];
15381
+ };
15382
+ };
15383
+ put?: never;
15384
+ post?: never;
15385
+ delete?: never;
15386
+ options?: never;
15387
+ head?: never;
15388
+ patch?: never;
15389
+ trace?: never;
15390
+ };
15118
15391
  "/trackFiles/{id}": {
15119
15392
  parameters: {
15120
15393
  query?: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tidal-music/api",
3
- "version": "0.11.0",
3
+ "version": "0.12.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.11.0"
21
+ "@tidal-music/api": "0.12.0"
22
22
  },
23
23
  "devDependencies": {
24
24
  "@vitest/coverage-v8": "4.1.0",
@@ -28,8 +28,8 @@
28
28
  "vite": "8.0.0",
29
29
  "vite-plugin-dts": "4.5.4",
30
30
  "vitest": "4.1.0",
31
- "@tidal-music/auth": "^1.4.0",
32
- "@tidal-music/common": "^0.2.0"
31
+ "@tidal-music/common": "^0.2.0",
32
+ "@tidal-music/auth": "^1.4.0"
33
33
  },
34
34
  "scripts": {
35
35
  "build": "vite build",