@tidal-music/api 0.32.0 → 0.34.0

package/dist/src/allAPI.generated.d.ts

@@ -5564,7 +5564,8 @@ export interface paths {
         get: {
             parameters: {
                 query: {
-                    refreshId?: string;
+                    /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
+                    refreshSeed?: string;
                     /**
                      * @description ISO 3166-1 alpha-2 country code
                      * @example US
@@ -5645,7 +5646,8 @@ export interface paths {
         get: {
             parameters: {
                 query: {
-                    refreshId?: string;
+                    /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
+                    refreshSeed?: string;
                     /**
                      * @description ISO 3166-1 alpha-2 country code
                      * @example US
@@ -5730,7 +5732,8 @@ export interface paths {
         get: {
             parameters: {
                 query: {
-                    refreshId?: string;
+                    /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
+                    refreshSeed?: string;
                     /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
                     "page[cursor]"?: string;
                     /**
@@ -5817,7 +5820,8 @@ export interface paths {
         get: {
             parameters: {
                 query: {
-                    refreshId?: string;
+                    /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
+                    refreshSeed?: string;
                     /**
                      * @description ISO 3166-1 alpha-2 country code
                      * @example US
@@ -5844,8 +5848,8 @@ export interface paths {
                      */
                     clientVersion: string;
                     /**
-                     * @description Allows the client to customize which related resources should be returned. Available options: dynamicModules, subject
-                     * @example dynamicModules
+                     * @description Allows the client to customize which related resources should be returned. Available options: modules, subject
+                     * @example modules
                      */
                     include?: string[];
                     /** @description type of the page (e.g. `ARTIST`) */
@@ -5886,7 +5890,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    "/dynamicPages/{id}/relationships/dynamicModules": {
+    "/dynamicPages/{id}/relationships/modules": {
         parameters: {
             query?: never;
             header?: never;
@@ -5894,13 +5898,14 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * Get dynamicModules relationship ("to-many").
-         * @description Retrieves dynamicModules relationship.
+         * Get modules relationship ("to-many").
+         * @description Retrieves modules relationship.
          */
         get: {
             parameters: {
                 query: {
-                    refreshId?: string;
+                    /** @description Stable seed used to keep dynamic page and module results consistent across a client session. */
+                    refreshSeed?: string;
                     /** @description Server-generated cursor value pointing a certain page of items. Optional, targets first page if not specified */
                     "page[cursor]"?: string;
                     /**
@@ -5929,8 +5934,8 @@ export interface paths {
                      */
                     clientVersion: string;
                     /**
-                     * @description Allows the client to customize which related resources should be returned. Available options: dynamicModules
-                     * @example dynamicModules
+                     * @description Allows the client to customize which related resources should be returned. Available options: modules
+                     * @example modules
                      */
                     include?: string[];
                 };
@@ -19201,6 +19206,7 @@ export interface components {
             type: string;
         };
         Albums_Items_Resource_Identifier_Meta: {
+            itemCursor?: string;
             /**
              * Format: int32
              * @description track number
@@ -20541,15 +20547,21 @@ export interface components {
         DynamicModules_Attributes: {
             /**
              * @description Type of icons the module should show
-             * @example SPOTLIGHT_ICON
+             * @example SPOTLIGHT_INFO
              */
             icons: ("SPOTLIGHT_INFO" | "UNKNOWN")[];
             /**
-             * @description Layout of the module preview on the dynamic page
+             * @description Semantic kind of the module, describing its product purpose and expected item domain.
+             * @example ALBUM_RELATED_ALBUMS
+             * @enum {string}
+             */
+            moduleKind: "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" | "ARTIST_DISCOGRAPHY" | "ALBUM_ITEMS" | "ALBUM_MORE_BY_ARTIST" | "ALBUM_OTHER_VERSIONS" | "ALBUM_RELATED_ALBUMS" | "ALBUM_RELATED_ARTISTS" | "COLLECTION_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" | "ARTIST_POPULAR_RELEASES" | "PURCHASES_FOR_YOU" | "UNKNOWN";
+            /**
+             * @description Presentation used when rendering the module preview on a dynamic page.
              * @example HORIZONTAL_LIST
              * @enum {string}
              */
-            previewLayout: "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" | "DISCOGRAPHY_TABS" | "MAGAZINE_LIST" | "HORIZONTAL_LIST" | "HORIZONTAL_LIST_WITH_CONTEXT" | "SHORTCUT_LIST" | "TRACK_LIST" | "VERTICAL_LIST_CARD" | "TEXT_CARD" | "LINKS_LIST" | "PUBLIC_PLAYLIST_LIST";
+            previewPresentation: "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" | "DISCOGRAPHY_TABS" | "MAGAZINE_LIST" | "HORIZONTAL_LIST" | "HORIZONTAL_LIST_WITH_CONTEXT" | "SHORTCUT_LIST" | "TRACK_LIST" | "VERTICAL_LIST_CARD" | "TEXT_CARD" | "LINKS_LIST" | "PUBLIC_PLAYLIST_LIST";
             /**
              * @description Subtitle of the module
              * @example Short description of this module
@@ -20561,11 +20573,11 @@ export interface components {
              */
             title?: string;
             /**
-             * @description Layout of the module's items in the view all screen
+             * @description Presentation used when rendering the module's items in the full view-all experience.
              * @example COMPACT
              * @enum {string}
              */
-            viewAllLayout: "COMPACT" | "GRID" | "UNKNOWN";
+            viewAllPresentation: "COMPACT" | "GRID" | "UNKNOWN";
         };
         DynamicModules_Multi_Relationship_Data_Document: {
             data?: components["schemas"]["Resource_Identifier"][];
@@ -20624,7 +20636,7 @@ export interface components {
             links: components["schemas"]["Links"];
         };
         DynamicPages_Relationships: {
-            dynamicModules?: components["schemas"]["Multi_Relationship_Data_Document"];
+            modules?: components["schemas"]["Multi_Relationship_Data_Document"];
             subject?: components["schemas"]["Single_Relationship_Data_Document"];
         };
         DynamicPages_Resource_Object: {
@@ -20634,6 +20646,7 @@ export interface components {
              * @example 12345
              */
             id: string;
+            meta?: components["schemas"]["DynamicPages_Resource_Object_Meta"];
             relationships?: components["schemas"]["DynamicPages_Relationships"];
             /**
              * @description Resource type (enum property replaced by openapi-typescript)
@@ -20641,6 +20654,13 @@ export interface components {
              */
             type: "dynamicPages";
         };
+        DynamicPages_Resource_Object_Meta: {
+            /**
+             * @description Reason why data has been redacted on this page
+             * @enum {string}
+             */
+            redactionReason?: "NO_BIRTHDAY" | "MINOR";
+        };
         DynamicPages_Single_Relationship_Data_Document: {
             data?: components["schemas"]["Resource_Identifier"];
             included?: components["schemas"]["Included"];
@@ -21232,7 +21252,7 @@ export interface components {
             batchId?: string;
             legacySource?: components["schemas"]["LegacySource"];
             /** @enum {string} */
-            mode: "ADD_TO_FRONT" | "ADD_TO_BACK" | "ADD_BEFORE" | "REPLACE_ALL";
+            mode: "ADD_TO_FRONT" | "ADD_TO_BACK" | "ADD_BEFORE" | "REPLACE_ALL" | "REPLACE_ALL_AND_CURRENT" | "ADD_TO_FRONT_REPLACE_CURRENT";
             positionBefore?: string;
         };
         PlayQueuesFutureRelationshipRemoveOperation_Payload: {
@@ -22518,12 +22538,16 @@ export interface components {
              * @example 12345
              */
             id: string;
+            meta?: components["schemas"]["Terms_Resource_Object_Meta"];
             /**
              * @description Resource type (enum property replaced by openapi-typescript)
              * @enum {string}
              */
             type: "terms";
         };
+        Terms_Resource_Object_Meta: {
+            isLatestVersion: boolean;
+        };
         Terms_Single_Resource_Data_Document: {
             data: components["schemas"]["Terms_Resource_Object"];
             included?: components["schemas"]["Included"];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tidal-music/api",
-  "version": "0.32.0",
+  "version": "0.34.0",
   "type": "module",
   "files": [
     "dist"