@utdk/spotify 1.0.0-20260407.6-dev.646adf4

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/types.ts ADDED
@@ -0,0 +1,578 @@
1
+ export type SpotifyClient = {
2
+ /**
3
+ * Add Items to Playlist
4
+ * Tags: Playlists, Tracks
5
+ * Access as: spotify.addItemsToPlaylist(input, options)
6
+ */
7
+ addItemsToPlaylist: (input: { uris?: (string)[]; position?: number; playlist_id: string; [key: string]: unknown }, options?: { query?: { position?: number; uris?: string } }) => Promise<{ snapshot_id?: string }>;
8
+ /**
9
+ * Add Item to Playback Queue
10
+ * Tags: Player
11
+ * Access as: spotify.addToQueue(input)
12
+ */
13
+ addToQueue: (input: { uri: string; device_id?: string }) => Promise<{ error: { status: number; message: string } }>;
14
+ /**
15
+ * Add Items to Playlist [DEPRECATED]
16
+ * Tags: Playlists, Tracks
17
+ * Access as: spotify.addTracksToPlaylist(input, options)
18
+ */
19
+ addTracksToPlaylist: (input: { uris?: (string)[]; position?: number; playlist_id: string; [key: string]: unknown }, options?: { query?: { position?: number; uris?: string } }) => Promise<{ snapshot_id?: string }>;
20
+ /**
21
+ * Change Playlist Details
22
+ * Tags: Playlists, Library
23
+ * Access as: spotify.changePlaylistDetails(input)
24
+ */
25
+ changePlaylistDetails: (input: { name?: string; public?: boolean; collaborative?: boolean; description?: string; playlist_id: string; [key: string]: unknown }) => Promise<{ error: { status: number; message: string } }>;
26
+ /**
27
+ * Check If User Follows Artists or Users
28
+ * Tags: Users, Artists, Library
29
+ * Access as: spotify.checkCurrentUserFollows(input)
30
+ */
31
+ checkCurrentUserFollows: (input: { type: "artist" | "user"; ids: string }) => Promise<(boolean)[]>;
32
+ /**
33
+ * Check if Current User Follows Playlist
34
+ * Tags: Users, Playlists
35
+ * Access as: spotify.checkIfUserFollowsPlaylist(input)
36
+ */
37
+ checkIfUserFollowsPlaylist: (input: { playlist_id: string; ids?: string }) => Promise<(boolean)[]>;
38
+ /**
39
+ * Check User's Saved Items
40
+ * Tags: Library
41
+ * Access as: spotify.checkLibraryContains(input)
42
+ */
43
+ checkLibraryContains: (input: { uris: string }) => Promise<(boolean)[]>;
44
+ /**
45
+ * Check User's Saved Albums
46
+ * Tags: Albums, Library
47
+ * Access as: spotify.checkUsersSavedAlbums(input)
48
+ */
49
+ checkUsersSavedAlbums: (input: { ids: string }) => Promise<(boolean)[]>;
50
+ /**
51
+ * Check User's Saved Audiobooks
52
+ * Tags: Audiobooks, Library
53
+ * Access as: spotify.checkUsersSavedAudiobooks(input)
54
+ */
55
+ checkUsersSavedAudiobooks: (input: { ids: string }) => Promise<(boolean)[]>;
56
+ /**
57
+ * Check User's Saved Episodes
58
+ * Tags: Episodes, Library
59
+ * Access as: spotify.checkUsersSavedEpisodes(input)
60
+ */
61
+ checkUsersSavedEpisodes: (input: { ids: string }) => Promise<(boolean)[]>;
62
+ /**
63
+ * Check User's Saved Shows
64
+ * Tags: Shows, Library
65
+ * Access as: spotify.checkUsersSavedShows(input)
66
+ */
67
+ checkUsersSavedShows: (input: { ids: string }) => Promise<(boolean)[]>;
68
+ /**
69
+ * Check User's Saved Tracks
70
+ * Tags: Tracks, Library
71
+ * Access as: spotify.checkUsersSavedTracks(input)
72
+ */
73
+ checkUsersSavedTracks: (input: { ids: string }) => Promise<(boolean)[]>;
74
+ /**
75
+ * Create Playlist
76
+ * Tags: Playlists, Library
77
+ * Access as: spotify.createPlaylist(input)
78
+ */
79
+ createPlaylist: (input: { name: string; public?: boolean; collaborative?: boolean; description?: string; [key: string]: unknown }) => Promise<{ collaborative?: boolean; description?: string | null; external_urls?: { spotify?: string }; href?: string; id?: string; images?: ({ url: string; height: number | null; width: number | null })[]; name?: string; owner?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: "user"; uri?: string } & { display_name?: string | null }; public?: boolean; snapshot_id?: string; items?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ added_at?: string; added_by?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: "user"; uri?: string }; is_local?: boolean; item?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } }; track?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } } })[] }; tracks?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ added_at?: string; added_by?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: "user"; uri?: string }; is_local?: boolean; item?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } }; track?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } } })[] }; type?: string; uri?: string }>;
80
+ /**
81
+ * Create Playlist for user
82
+ * Tags: Playlists, Library
83
+ * Access as: spotify.createPlaylistForUser(input)
84
+ */
85
+ createPlaylistForUser: (input: { name: string; public?: boolean; collaborative?: boolean; description?: string; user_id: string; [key: string]: unknown }) => Promise<{ collaborative?: boolean; description?: string | null; external_urls?: { spotify?: string }; href?: string; id?: string; images?: ({ url: string; height: number | null; width: number | null })[]; name?: string; owner?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: "user"; uri?: string } & { display_name?: string | null }; public?: boolean; snapshot_id?: string; items?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ added_at?: string; added_by?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: "user"; uri?: string }; is_local?: boolean; item?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } }; track?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } } })[] }; tracks?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ added_at?: string; added_by?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: "user"; uri?: string }; is_local?: boolean; item?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } }; track?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } } })[] }; type?: string; uri?: string }>;
86
+ /**
87
+ * Follow Artists or Users
88
+ * Tags: Users, Artists, Library
89
+ * Access as: spotify.followArtistsUsers(input, options)
90
+ */
91
+ followArtistsUsers: (input: { ids: (string)[]; type: "artist" | "user"; [key: string]: unknown }, options: { query: { ids: string } }) => Promise<{ error: { status: number; message: string } }>;
92
+ /**
93
+ * Follow Playlist
94
+ * Tags: Users, Playlists
95
+ * Access as: spotify.followPlaylist(input)
96
+ */
97
+ followPlaylist: (input: { public?: boolean; playlist_id: string; [key: string]: unknown }) => Promise<{ error: { status: number; message: string } }>;
98
+ /**
99
+ * Get Category's Playlists
100
+ * Tags: Playlists, Categories
101
+ * Access as: spotify.getACategoriesPlaylists(input)
102
+ */
103
+ getACategoriesPlaylists: (input: { category_id: string; limit?: number; offset?: number }) => Promise<{ message?: string; playlists?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ collaborative?: boolean; description?: string; external_urls?: { spotify?: string }; href?: string; id?: string; images?: ({ url: string; height: number | null; width: number | null })[]; name?: string; owner?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: "user"; uri?: string } & { display_name?: string | null }; public?: boolean; snapshot_id?: string; items?: { href?: string; total?: number }; tracks?: { href?: string; total?: number }; type?: string; uri?: string })[] } }>;
104
+ /**
105
+ * Get Single Browse Category
106
+ * Tags: Categories
107
+ * Access as: spotify.getACategory(input)
108
+ */
109
+ getACategory: (input: { category_id: string; locale?: string }) => Promise<{ href: string; icons: ({ url: string; height: number | null; width: number | null })[]; id: string; name: string }>;
110
+ /**
111
+ * Get a Chapter
112
+ * Tags: Chapters
113
+ * Access as: spotify.getAChapter(input)
114
+ */
115
+ getAChapter: (input: { id: string; market?: string }) => Promise<{ audio_preview_url: string | null; available_markets?: (string)[]; chapter_number: number; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_playable: boolean; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { audiobook: { authors: ({ name?: string })[]; available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; edition?: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; languages: (string)[]; media_type: string; name: string; narrators: ({ name?: string })[]; publisher: string; type: "audiobook"; uri: string; total_chapters: number } & { [key: string]: unknown } }>;
116
+ /**
117
+ * Get Current User's Playlists
118
+ * Tags: Playlists, Library
119
+ * Access as: spotify.getAListOfCurrentUsersPlaylists(input)
120
+ */
121
+ getAListOfCurrentUsersPlaylists: (input: { limit?: number; offset?: number }) => Promise<{ href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ collaborative?: boolean; description?: string; external_urls?: { spotify?: string }; href?: string; id?: string; images?: ({ url: string; height: number | null; width: number | null })[]; name?: string; owner?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: "user"; uri?: string } & { display_name?: string | null }; public?: boolean; snapshot_id?: string; items?: { href?: string; total?: number }; tracks?: { href?: string; total?: number }; type?: string; uri?: string })[] }>;
122
+ /**
123
+ * Get Album
124
+ * Tags: Albums
125
+ * Access as: spotify.getAnAlbum(input)
126
+ */
127
+ getAnAlbum: (input: { id: string; market?: string }) => Promise<{ album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; tracks?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: string; uri?: string }; restrictions?: { reason?: string }; name?: string; preview_url?: string | null; track_number?: number; type?: string; uri?: string; is_local?: boolean })[] }; copyrights?: ({ text?: string; type?: string })[]; external_ids?: { isrc?: string; ean?: string; upc?: string }; genres?: (string)[]; label?: string; popularity?: number }>;
128
+ /**
129
+ * Get Album Tracks
130
+ * Tags: Albums, Tracks
131
+ * Access as: spotify.getAnAlbumsTracks(input)
132
+ */
133
+ getAnAlbumsTracks: (input: { id: string; market?: string; limit?: number; offset?: number }) => Promise<{ href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: string; uri?: string }; restrictions?: { reason?: string }; name?: string; preview_url?: string | null; track_number?: number; type?: string; uri?: string; is_local?: boolean })[] }>;
134
+ /**
135
+ * Get Artist
136
+ * Tags: Artists
137
+ * Access as: spotify.getAnArtist(input)
138
+ */
139
+ getAnArtist: (input: { id: string }) => Promise<{ external_urls?: { spotify?: string }; followers?: { href?: string | null; total?: number }; genres?: (string)[]; href?: string; id?: string; images?: ({ url: string; height: number | null; width: number | null })[]; name?: string; popularity?: number; type?: "artist"; uri?: string }>;
140
+ /**
141
+ * Get Artist's Albums
142
+ * Tags: Artists, Albums
143
+ * Access as: spotify.getAnArtistsAlbums(input)
144
+ */
145
+ getAnArtistsAlbums: (input: { id: string; include_groups?: string; market?: string; limit?: number; offset?: number }) => Promise<{ href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] } & { album_group: "album" | "single" | "compilation" | "appears_on" })[] }>;
146
+ /**
147
+ * Get Artist's Related Artists
148
+ * Tags: Artists
149
+ * Access as: spotify.getAnArtistsRelatedArtists(input)
150
+ */
151
+ getAnArtistsRelatedArtists: (input: { id: string }) => Promise<{ artists: ({ external_urls?: { spotify?: string }; followers?: { href?: string | null; total?: number }; genres?: (string)[]; href?: string; id?: string; images?: ({ url: string; height: number | null; width: number | null })[]; name?: string; popularity?: number; type?: "artist"; uri?: string })[] }>;
152
+ /**
153
+ * Get Artist's Top Tracks
154
+ * Tags: Artists, Tracks
155
+ * Access as: spotify.getAnArtistsTopTracks(input)
156
+ */
157
+ getAnArtistsTopTracks: (input: { id: string; market?: string }) => Promise<{ tracks: ({ album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean })[] }>;
158
+ /**
159
+ * Get an Audiobook
160
+ * Tags: Audiobooks
161
+ * Access as: spotify.getAnAudiobook(input)
162
+ */
163
+ getAnAudiobook: (input: { id: string; market?: string }) => Promise<{ authors: ({ name?: string })[]; available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; edition?: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; languages: (string)[]; media_type: string; name: string; narrators: ({ name?: string })[]; publisher: string; type: "audiobook"; uri: string; total_chapters: number } & { chapters: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ audio_preview_url: string | null; available_markets?: (string)[]; chapter_number: number; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_playable: boolean; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { [key: string]: unknown })[] } }>;
164
+ /**
165
+ * Get Episode
166
+ * Tags: Episodes
167
+ * Access as: spotify.getAnEpisode(input)
168
+ */
169
+ getAnEpisode: (input: { id: string; market?: string }) => Promise<{ audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } }>;
170
+ /**
171
+ * Get Show
172
+ * Tags: Shows
173
+ * Access as: spotify.getAShow(input)
174
+ */
175
+ getAShow: (input: { id: string; market?: string }) => Promise<{ available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { episodes: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { [key: string]: unknown })[] } }>;
176
+ /**
177
+ * Get Show Episodes
178
+ * Tags: Shows, Episodes
179
+ * Access as: spotify.getAShowsEpisodes(input)
180
+ */
181
+ getAShowsEpisodes: (input: { id: string; market?: string; limit?: number; offset?: number }) => Promise<{ href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { [key: string]: unknown })[] }>;
182
+ /**
183
+ * Get Track's Audio Analysis
184
+ * Tags: Tracks
185
+ * Access as: spotify.getAudioAnalysis(input)
186
+ */
187
+ getAudioAnalysis: (input: { id: string }) => Promise<{ meta?: { analyzer_version?: string; platform?: string; detailed_status?: string; status_code?: number; timestamp?: number; analysis_time?: number; input_process?: string }; track?: { num_samples?: number; duration?: number; sample_md5?: string; offset_seconds?: number; window_seconds?: number; analysis_sample_rate?: number; analysis_channels?: number; end_of_fade_in?: number; start_of_fade_out?: number; loudness?: number; tempo?: number; tempo_confidence?: number; time_signature?: number; time_signature_confidence?: number; key?: number; key_confidence?: number; mode?: number; mode_confidence?: number; codestring?: string; code_version?: number; echoprintstring?: string; echoprint_version?: number; synchstring?: string; synch_version?: number; rhythmstring?: string; rhythm_version?: number }; bars?: ({ start?: number; duration?: number; confidence?: number })[]; beats?: ({ start?: number; duration?: number; confidence?: number })[]; sections?: ({ start?: number; duration?: number; confidence?: number; loudness?: number; tempo?: number; tempo_confidence?: number; key?: number; key_confidence?: number; mode?: -1 | 0 | 1; mode_confidence?: number; time_signature?: number; time_signature_confidence?: number })[]; segments?: ({ start?: number; duration?: number; confidence?: number; loudness_start?: number; loudness_max?: number; loudness_max_time?: number; loudness_end?: number; pitches?: (number)[]; timbre?: (number)[] })[]; tatums?: ({ start?: number; duration?: number; confidence?: number })[] }>;
188
+ /**
189
+ * Get Audiobook Chapters
190
+ * Tags: Audiobooks, Chapters
191
+ * Access as: spotify.getAudiobookChapters(input)
192
+ */
193
+ getAudiobookChapters: (input: { id: string; market?: string; limit?: number; offset?: number }) => Promise<{ href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ audio_preview_url: string | null; available_markets?: (string)[]; chapter_number: number; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_playable: boolean; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { [key: string]: unknown })[] }>;
194
+ /**
195
+ * Get Track's Audio Features
196
+ * Tags: Tracks
197
+ * Access as: spotify.getAudioFeatures(input)
198
+ */
199
+ getAudioFeatures: (input: { id: string }) => Promise<{ acousticness?: number; analysis_url?: string; danceability?: number; duration_ms?: number; energy?: number; id?: string; instrumentalness?: number; key?: number; liveness?: number; loudness?: number; mode?: number; speechiness?: number; tempo?: number; time_signature?: number; track_href?: string; type?: "audio_features"; uri?: string; valence?: number }>;
200
+ /**
201
+ * Get Available Devices
202
+ * Tags: Player
203
+ * Access as: spotify.getAUsersAvailableDevices()
204
+ */
205
+ getAUsersAvailableDevices: () => Promise<{ devices: ({ id?: string | null; is_active?: boolean; is_private_session?: boolean; is_restricted?: boolean; name?: string; type?: string; volume_percent?: number | null; supports_volume?: boolean })[] }>;
206
+ /**
207
+ * Get Available Markets
208
+ * Tags: Markets
209
+ * Access as: spotify.getAvailableMarkets()
210
+ */
211
+ getAvailableMarkets: () => Promise<{ markets?: (string)[] }>;
212
+ /**
213
+ * Get Several Browse Categories
214
+ * Tags: Categories
215
+ * Access as: spotify.getCategories(input)
216
+ */
217
+ getCategories: (input: { locale?: string; limit?: number; offset?: number }) => Promise<{ categories: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ href: string; icons: ({ url: string; height: number | null; width: number | null })[]; id: string; name: string })[] } }>;
218
+ /**
219
+ * Get Current User's Profile
220
+ * Tags: Users
221
+ * Access as: spotify.getCurrentUsersProfile()
222
+ */
223
+ getCurrentUsersProfile: () => Promise<{ country?: string; display_name?: string; email?: string; explicit_content?: { filter_enabled?: boolean; filter_locked?: boolean }; external_urls?: { spotify?: string }; followers?: { href?: string | null; total?: number }; href?: string; id?: string; images?: ({ url: string; height: number | null; width: number | null })[]; product?: string; type?: string; uri?: string }>;
224
+ /**
225
+ * Get Featured Playlists
226
+ * Tags: Playlists
227
+ * Access as: spotify.getFeaturedPlaylists(input)
228
+ */
229
+ getFeaturedPlaylists: (input: { locale?: string; limit?: number; offset?: number }) => Promise<{ message?: string; playlists?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ collaborative?: boolean; description?: string; external_urls?: { spotify?: string }; href?: string; id?: string; images?: ({ url: string; height: number | null; width: number | null })[]; name?: string; owner?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: "user"; uri?: string } & { display_name?: string | null }; public?: boolean; snapshot_id?: string; items?: { href?: string; total?: number }; tracks?: { href?: string; total?: number }; type?: string; uri?: string })[] } }>;
230
+ /**
231
+ * Get Followed Artists
232
+ * Tags: Users, Library, Artists
233
+ * Access as: spotify.getFollowed(input)
234
+ */
235
+ getFollowed: (input: { type: "artist"; after?: string; limit?: number }) => Promise<{ artists: { href?: string; limit?: number; next?: string; cursors?: { after?: string; before?: string }; total?: number } & { items?: ({ external_urls?: { spotify?: string }; followers?: { href?: string | null; total?: number }; genres?: (string)[]; href?: string; id?: string; images?: ({ url: string; height: number | null; width: number | null })[]; name?: string; popularity?: number; type?: "artist"; uri?: string })[] } }>;
236
+ /**
237
+ * Get Playback State
238
+ * Tags: Player
239
+ * Access as: spotify.getInformationAboutTheUsersCurrentPlayback(input)
240
+ */
241
+ getInformationAboutTheUsersCurrentPlayback: (input: { market?: string; additional_types?: string }) => Promise<{ device?: { id?: string | null; is_active?: boolean; is_private_session?: boolean; is_restricted?: boolean; name?: string; type?: string; volume_percent?: number | null; supports_volume?: boolean }; repeat_state?: string; shuffle_state?: boolean; context?: { type?: string; href?: string; external_urls?: { spotify?: string }; uri?: string }; timestamp?: number; progress_ms?: number; is_playing?: boolean; item?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } }; currently_playing_type?: string; actions?: { interrupting_playback?: boolean; pausing?: boolean; resuming?: boolean; seeking?: boolean; skipping_next?: boolean; skipping_prev?: boolean; toggling_repeat_context?: boolean; toggling_shuffle?: boolean; toggling_repeat_track?: boolean; transferring_playback?: boolean } }>;
242
+ /**
243
+ * Get User's Playlists
244
+ * Tags: Playlists, Users
245
+ * Access as: spotify.getListUsersPlaylists(input)
246
+ */
247
+ getListUsersPlaylists: (input: { user_id: string; limit?: number; offset?: number }) => Promise<{ href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ collaborative?: boolean; description?: string; external_urls?: { spotify?: string }; href?: string; id?: string; images?: ({ url: string; height: number | null; width: number | null })[]; name?: string; owner?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: "user"; uri?: string } & { display_name?: string | null }; public?: boolean; snapshot_id?: string; items?: { href?: string; total?: number }; tracks?: { href?: string; total?: number }; type?: string; uri?: string })[] }>;
248
+ /**
249
+ * Get Several Albums
250
+ * Tags: Albums
251
+ * Access as: spotify.getMultipleAlbums(input)
252
+ */
253
+ getMultipleAlbums: (input: { ids: string; market?: string }) => Promise<{ albums: ({ album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; tracks?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: string; uri?: string }; restrictions?: { reason?: string }; name?: string; preview_url?: string | null; track_number?: number; type?: string; uri?: string; is_local?: boolean })[] }; copyrights?: ({ text?: string; type?: string })[]; external_ids?: { isrc?: string; ean?: string; upc?: string }; genres?: (string)[]; label?: string; popularity?: number })[] }>;
254
+ /**
255
+ * Get Several Artists
256
+ * Tags: Artists
257
+ * Access as: spotify.getMultipleArtists(input)
258
+ */
259
+ getMultipleArtists: (input: { ids: string }) => Promise<{ artists: ({ external_urls?: { spotify?: string }; followers?: { href?: string | null; total?: number }; genres?: (string)[]; href?: string; id?: string; images?: ({ url: string; height: number | null; width: number | null })[]; name?: string; popularity?: number; type?: "artist"; uri?: string })[] }>;
260
+ /**
261
+ * Get Several Audiobooks
262
+ * Tags: Audiobooks
263
+ * Access as: spotify.getMultipleAudiobooks(input)
264
+ */
265
+ getMultipleAudiobooks: (input: { ids: string; market?: string }) => Promise<{ audiobooks: ({ authors: ({ name?: string })[]; available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; edition?: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; languages: (string)[]; media_type: string; name: string; narrators: ({ name?: string })[]; publisher: string; type: "audiobook"; uri: string; total_chapters: number } & { chapters: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ audio_preview_url: string | null; available_markets?: (string)[]; chapter_number: number; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_playable: boolean; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { [key: string]: unknown })[] } })[] }>;
266
+ /**
267
+ * Get Several Episodes
268
+ * Tags: Episodes
269
+ * Access as: spotify.getMultipleEpisodes(input)
270
+ */
271
+ getMultipleEpisodes: (input: { ids: string; market?: string }) => Promise<{ episodes: ({ audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } })[] }>;
272
+ /**
273
+ * Get Several Shows
274
+ * Tags: Shows
275
+ * Access as: spotify.getMultipleShows(input)
276
+ */
277
+ getMultipleShows: (input: { market?: string; ids: string }) => Promise<{ shows: ({ available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown })[] }>;
278
+ /**
279
+ * Get New Releases
280
+ * Tags: Albums
281
+ * Access as: spotify.getNewReleases(input)
282
+ */
283
+ getNewReleases: (input: { limit?: number; offset?: number }) => Promise<{ albums: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] })[] } }>;
284
+ /**
285
+ * Get Playlist
286
+ * Tags: Playlists
287
+ * Access as: spotify.getPlaylist(input)
288
+ */
289
+ getPlaylist: (input: { playlist_id: string; market?: string; fields?: string; additional_types?: string }) => Promise<{ collaborative?: boolean; description?: string | null; external_urls?: { spotify?: string }; href?: string; id?: string; images?: ({ url: string; height: number | null; width: number | null })[]; name?: string; owner?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: "user"; uri?: string } & { display_name?: string | null }; public?: boolean; snapshot_id?: string; items?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ added_at?: string; added_by?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: "user"; uri?: string }; is_local?: boolean; item?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } }; track?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } } })[] }; tracks?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ added_at?: string; added_by?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: "user"; uri?: string }; is_local?: boolean; item?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } }; track?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } } })[] }; type?: string; uri?: string }>;
290
+ /**
291
+ * Get Playlist Cover Image
292
+ * Tags: Playlists
293
+ * Access as: spotify.getPlaylistCover(input)
294
+ */
295
+ getPlaylistCover: (input: { playlist_id: string }) => Promise<({ url: string; height: number | null; width: number | null })[]>;
296
+ /**
297
+ * Get Playlist Items
298
+ * Tags: Playlists, Tracks
299
+ * Access as: spotify.getPlaylistsItems(input)
300
+ */
301
+ getPlaylistsItems: (input: { playlist_id: string; market?: string; fields?: string; limit?: number; offset?: number; additional_types?: string }) => Promise<{ href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ added_at?: string; added_by?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: "user"; uri?: string }; is_local?: boolean; item?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } }; track?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } } })[] }>;
302
+ /**
303
+ * Get Playlist Items [DEPRECATED]
304
+ * Tags: Playlists, Tracks
305
+ * Access as: spotify.getPlaylistsTracks(input)
306
+ */
307
+ getPlaylistsTracks: (input: { playlist_id: string; market?: string; fields?: string; limit?: number; offset?: number; additional_types?: string }) => Promise<{ href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ added_at?: string; added_by?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: "user"; uri?: string }; is_local?: boolean; item?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } }; track?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } } })[] }>;
308
+ /**
309
+ * Get the User's Queue
310
+ * Tags: Player
311
+ * Access as: spotify.getQueue()
312
+ */
313
+ getQueue: () => Promise<{ currently_playing?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } }; queue?: ({ album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } })[] }>;
314
+ /**
315
+ * Get Recently Played Tracks
316
+ * Tags: Player
317
+ * Access as: spotify.getRecentlyPlayed(input)
318
+ */
319
+ getRecentlyPlayed: (input: { limit?: number; after?: number; before?: number }) => Promise<{ href?: string; limit?: number; next?: string; cursors?: { after?: string; before?: string }; total?: number } & { items?: ({ track?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean }; played_at?: string; context?: { type?: string; href?: string; external_urls?: { spotify?: string }; uri?: string } })[] }>;
320
+ /**
321
+ * Get Available Genre Seeds
322
+ * Tags: Genres
323
+ * Access as: spotify.getRecommendationGenres()
324
+ */
325
+ getRecommendationGenres: () => Promise<{ genres: (string)[] }>;
326
+ /**
327
+ * Get Recommendations
328
+ * Tags: Tracks
329
+ * Access as: spotify.getRecommendations(input)
330
+ */
331
+ getRecommendations: (input: { limit?: number; market?: string; seed_artists: string; seed_genres: string; seed_tracks: string; min_acousticness?: number; max_acousticness?: number; target_acousticness?: number; min_danceability?: number; max_danceability?: number; target_danceability?: number; min_duration_ms?: number; max_duration_ms?: number; target_duration_ms?: number; min_energy?: number; max_energy?: number; target_energy?: number; min_instrumentalness?: number; max_instrumentalness?: number; target_instrumentalness?: number; min_key?: number; max_key?: number; target_key?: number; min_liveness?: number; max_liveness?: number; target_liveness?: number; min_loudness?: number; max_loudness?: number; target_loudness?: number; min_mode?: number; max_mode?: number; target_mode?: number; min_popularity?: number; max_popularity?: number; target_popularity?: number; min_speechiness?: number; max_speechiness?: number; target_speechiness?: number; min_tempo?: number; max_tempo?: number; target_tempo?: number; min_time_signature?: number; max_time_signature?: number; target_time_signature?: number; min_valence?: number; max_valence?: number; target_valence?: number }) => Promise<{ seeds: ({ afterFilteringSize?: number; afterRelinkingSize?: number; href?: string; id?: string; initialPoolSize?: number; type?: string })[]; tracks: ({ album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean })[] }>;
332
+ /**
333
+ * Get Several Tracks' Audio Features
334
+ * Tags: Tracks
335
+ * Access as: spotify.getSeveralAudioFeatures(input)
336
+ */
337
+ getSeveralAudioFeatures: (input: { ids: string }) => Promise<{ audio_features: ({ acousticness?: number; analysis_url?: string; danceability?: number; duration_ms?: number; energy?: number; id?: string; instrumentalness?: number; key?: number; liveness?: number; loudness?: number; mode?: number; speechiness?: number; tempo?: number; time_signature?: number; track_href?: string; type?: "audio_features"; uri?: string; valence?: number })[] }>;
338
+ /**
339
+ * Get Several Chapters
340
+ * Tags: Chapters
341
+ * Access as: spotify.getSeveralChapters(input)
342
+ */
343
+ getSeveralChapters: (input: { ids: string; market?: string }) => Promise<{ chapters: ({ audio_preview_url: string | null; available_markets?: (string)[]; chapter_number: number; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_playable: boolean; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { audiobook: { authors: ({ name?: string })[]; available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; edition?: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; languages: (string)[]; media_type: string; name: string; narrators: ({ name?: string })[]; publisher: string; type: "audiobook"; uri: string; total_chapters: number } & { [key: string]: unknown } })[] }>;
344
+ /**
345
+ * Get Several Tracks
346
+ * Tags: Tracks
347
+ * Access as: spotify.getSeveralTracks(input)
348
+ */
349
+ getSeveralTracks: (input: { market?: string; ids: string }) => Promise<{ tracks: ({ album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean })[] }>;
350
+ /**
351
+ * Get Currently Playing Track
352
+ * Tags: Player
353
+ * Access as: spotify.getTheUsersCurrentlyPlayingTrack(input)
354
+ */
355
+ getTheUsersCurrentlyPlayingTrack: (input: { market?: string; additional_types?: string }) => Promise<{ device?: { id?: string | null; is_active?: boolean; is_private_session?: boolean; is_restricted?: boolean; name?: string; type?: string; volume_percent?: number | null; supports_volume?: boolean }; repeat_state?: string; shuffle_state?: boolean; context?: { type?: string; href?: string; external_urls?: { spotify?: string }; uri?: string }; timestamp?: number; progress_ms?: number; is_playing?: boolean; item?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } | { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } }; currently_playing_type?: string; actions?: { interrupting_playback?: boolean; pausing?: boolean; resuming?: boolean; seeking?: boolean; skipping_next?: boolean; skipping_prev?: boolean; toggling_repeat_context?: boolean; toggling_shuffle?: boolean; toggling_repeat_track?: boolean; transferring_playback?: boolean } }>;
356
+ /**
357
+ * Get Track
358
+ * Tags: Tracks
359
+ * Access as: spotify.getTrack(input)
360
+ */
361
+ getTrack: (input: { id: string; market?: string }) => Promise<{ album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean }>;
362
+ /**
363
+ * Get User's Profile
364
+ * Tags: Users
365
+ * Access as: spotify.getUsersProfile(input)
366
+ */
367
+ getUsersProfile: (input: { user_id: string }) => Promise<{ display_name?: string | null; external_urls?: { spotify?: string }; followers?: { href?: string | null; total?: number }; href?: string; id?: string; images?: ({ url: string; height: number | null; width: number | null })[]; type?: "user"; uri?: string }>;
368
+ /**
369
+ * Get User's Saved Albums
370
+ * Tags: Albums, Library
371
+ * Access as: spotify.getUsersSavedAlbums(input)
372
+ */
373
+ getUsersSavedAlbums: (input: { limit?: number; offset?: number; market?: string }) => Promise<{ href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ added_at?: string; album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; tracks?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: string; uri?: string }; restrictions?: { reason?: string }; name?: string; preview_url?: string | null; track_number?: number; type?: string; uri?: string; is_local?: boolean })[] }; copyrights?: ({ text?: string; type?: string })[]; external_ids?: { isrc?: string; ean?: string; upc?: string }; genres?: (string)[]; label?: string; popularity?: number } })[] }>;
374
+ /**
375
+ * Get User's Saved Audiobooks
376
+ * Tags: Audiobooks, Library
377
+ * Access as: spotify.getUsersSavedAudiobooks(input)
378
+ */
379
+ getUsersSavedAudiobooks: (input: { limit?: number; offset?: number }) => Promise<{ href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ authors: ({ name?: string })[]; available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; edition?: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; languages: (string)[]; media_type: string; name: string; narrators: ({ name?: string })[]; publisher: string; type: "audiobook"; uri: string; total_chapters: number } & { [key: string]: unknown })[] }>;
380
+ /**
381
+ * Get User's Saved Episodes
382
+ * Tags: Episodes, Library
383
+ * Access as: spotify.getUsersSavedEpisodes(input)
384
+ */
385
+ getUsersSavedEpisodes: (input: { market?: string; limit?: number; offset?: number }) => Promise<{ href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ added_at?: string; episode?: { audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { show: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } } })[] }>;
386
+ /**
387
+ * Get User's Saved Shows
388
+ * Tags: Shows, Library
389
+ * Access as: spotify.getUsersSavedShows(input)
390
+ */
391
+ getUsersSavedShows: (input: { limit?: number; offset?: number }) => Promise<{ href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ added_at?: string; show?: { available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown } })[] }>;
392
+ /**
393
+ * Get User's Saved Tracks
394
+ * Tags: Tracks, Library
395
+ * Access as: spotify.getUsersSavedTracks(input)
396
+ */
397
+ getUsersSavedTracks: (input: { market?: string; limit?: number; offset?: number }) => Promise<{ href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ added_at?: string; track?: { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean } })[] }>;
398
+ /**
399
+ * Get User's Top Items
400
+ * Tags: Users, Tracks, Library
401
+ * Access as: spotify.getUsersTopArtistsAndTracks(input)
402
+ */
403
+ getUsersTopArtistsAndTracks: (input: { type: "artists" | "tracks"; time_range?: string; limit?: number; offset?: number }) => Promise<{ href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ external_urls?: { spotify?: string }; followers?: { href?: string | null; total?: number }; genres?: (string)[]; href?: string; id?: string; images?: ({ url: string; height: number | null; width: number | null })[]; name?: string; popularity?: number; type?: "artist"; uri?: string } | { album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean })[] }>;
404
+ /**
405
+ * Pause Playback
406
+ * Tags: Player
407
+ * Access as: spotify.pauseAUsersPlayback(input)
408
+ */
409
+ pauseAUsersPlayback: (input: { device_id?: string }) => Promise<{ error: { status: number; message: string } }>;
410
+ /**
411
+ * Remove Users' Saved Albums
412
+ * Tags: Albums, Library
413
+ * Access as: spotify.removeAlbumsUser(input, options)
414
+ */
415
+ removeAlbumsUser: (input: { ids?: (string)[]; [key: string]: unknown }, options: { query: { ids: string } }) => Promise<{ error: { status: number; message: string } }>;
416
+ /**
417
+ * Remove User's Saved Audiobooks
418
+ * Tags: Audiobooks, Library
419
+ * Access as: spotify.removeAudiobooksUser(input)
420
+ */
421
+ removeAudiobooksUser: (input: { ids: string }) => Promise<{ error: { status: number; message: string } }>;
422
+ /**
423
+ * Remove User's Saved Episodes
424
+ * Tags: Episodes, Library
425
+ * Access as: spotify.removeEpisodesUser(input, options)
426
+ */
427
+ removeEpisodesUser: (input: { ids?: (string)[]; [key: string]: unknown }, options: { query: { ids: string } }) => Promise<{ error: { status: number; message: string } }>;
428
+ /**
429
+ * Remove Playlist Items
430
+ * Tags: Playlists, Tracks
431
+ * Access as: spotify.removeItemsPlaylist(input)
432
+ */
433
+ removeItemsPlaylist: (input: { items: ({ uri?: string })[]; snapshot_id?: string; playlist_id: string }) => Promise<{ snapshot_id?: string }>;
434
+ /**
435
+ * Remove Items from Library
436
+ * Tags: Library
437
+ * Access as: spotify.removeLibraryItems(input)
438
+ */
439
+ removeLibraryItems: (input: { uris: string }) => Promise<{ status: number; message: string }>;
440
+ /**
441
+ * Remove User's Saved Shows
442
+ * Tags: Shows, Library
443
+ * Access as: spotify.removeShowsUser(input)
444
+ */
445
+ removeShowsUser: (input: { ids: string; market?: string }) => Promise<{ error: { status: number; message: string } }>;
446
+ /**
447
+ * Remove Playlist Items [DEPRECATED]
448
+ * Tags: Playlists, Tracks
449
+ * Access as: spotify.removeTracksPlaylist(input)
450
+ */
451
+ removeTracksPlaylist: (input: { tracks: ({ uri?: string })[]; snapshot_id?: string; playlist_id: string }) => Promise<{ snapshot_id?: string }>;
452
+ /**
453
+ * Remove User's Saved Tracks
454
+ * Tags: Tracks, Library
455
+ * Access as: spotify.removeTracksUser(input, options)
456
+ */
457
+ removeTracksUser: (input: { ids?: (string)[]; [key: string]: unknown }, options: { query: { ids: string } }) => Promise<{ error: { status: number; message: string } }>;
458
+ /**
459
+ * Update Playlist Items
460
+ * Tags: Playlists, Tracks
461
+ * Access as: spotify.reorderOrReplacePlaylistsItems(input, options)
462
+ */
463
+ reorderOrReplacePlaylistsItems: (input: { uris?: (string)[]; range_start?: number; insert_before?: number; range_length?: number; snapshot_id?: string; playlist_id: string; [key: string]: unknown }, options?: { query?: { uris?: string } }) => Promise<{ snapshot_id?: string }>;
464
+ /**
465
+ * Update Playlist Items [DEPRECATED]
466
+ * Tags: Playlists, Tracks
467
+ * Access as: spotify.reorderOrReplacePlaylistsTracks(input, options)
468
+ */
469
+ reorderOrReplacePlaylistsTracks: (input: { uris?: (string)[]; range_start?: number; insert_before?: number; range_length?: number; snapshot_id?: string; playlist_id: string; [key: string]: unknown }, options?: { query?: { uris?: string } }) => Promise<{ snapshot_id?: string }>;
470
+ /**
471
+ * Save Albums for Current User
472
+ * Tags: Albums, Library
473
+ * Access as: spotify.saveAlbumsUser(input, options)
474
+ */
475
+ saveAlbumsUser: (input: { ids?: (string)[]; [key: string]: unknown }, options: { query: { ids: string } }) => Promise<{ error: { status: number; message: string } }>;
476
+ /**
477
+ * Save Audiobooks for Current User
478
+ * Tags: Audiobooks, Library
479
+ * Access as: spotify.saveAudiobooksUser(input)
480
+ */
481
+ saveAudiobooksUser: (input: { ids: string }) => Promise<{ error: { status: number; message: string } }>;
482
+ /**
483
+ * Save Episodes for Current User
484
+ * Tags: Episodes, Library
485
+ * Access as: spotify.saveEpisodesUser(input, options)
486
+ */
487
+ saveEpisodesUser: (input: { ids?: (string)[]; [key: string]: unknown }, options: { query: { ids: string } }) => Promise<{ error: { status: number; message: string } }>;
488
+ /**
489
+ * Save Items to Library
490
+ * Tags: Library
491
+ * Access as: spotify.saveLibraryItems(input)
492
+ */
493
+ saveLibraryItems: (input: { uris: string }) => Promise<{ status: number; message: string }>;
494
+ /**
495
+ * Save Shows for Current User
496
+ * Tags: Shows, Library
497
+ * Access as: spotify.saveShowsUser(input)
498
+ */
499
+ saveShowsUser: (input: { ids: string }) => Promise<{ error: { status: number; message: string } }>;
500
+ /**
501
+ * Save Tracks for Current User
502
+ * Tags: Tracks, Library
503
+ * Access as: spotify.saveTracksUser(input)
504
+ */
505
+ saveTracksUser: (input: { ids?: (string)[]; timestamped_ids?: ({ id: string; added_at: string })[]; [key: string]: unknown }) => Promise<{ error: { status: number; message: string } }>;
506
+ /**
507
+ * Search for Item
508
+ * Tags: Search
509
+ * Access as: spotify.search(input)
510
+ */
511
+ search: (input: { q: string; type: ("album" | "artist" | "playlist" | "track" | "show" | "episode" | "audiobook")[]; market?: string; limit?: number; offset?: number; include_external?: "audio" }) => Promise<{ tracks?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ album?: { album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] }; artists?: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[]; available_markets?: (string)[]; disc_number?: number; duration_ms?: number; explicit?: boolean; external_ids?: { isrc?: string; ean?: string; upc?: string }; external_urls?: { spotify?: string }; href?: string; id?: string; is_playable?: boolean; linked_from?: { [key: string]: unknown }; restrictions?: { reason?: string }; name?: string; popularity?: number; preview_url?: string | null; track_number?: number; type?: "track"; uri?: string; is_local?: boolean })[] }; artists?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ external_urls?: { spotify?: string }; followers?: { href?: string | null; total?: number }; genres?: (string)[]; href?: string; id?: string; images?: ({ url: string; height: number | null; width: number | null })[]; name?: string; popularity?: number; type?: "artist"; uri?: string })[] }; albums?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ album_type: "album" | "single" | "compilation"; total_tracks: number; available_markets: (string)[]; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; restrictions?: { reason?: "market" | "product" | "explicit" }; type: "album"; uri: string } & { artists: ({ external_urls?: { spotify?: string }; href?: string; id?: string; name?: string; type?: "artist"; uri?: string })[] })[] }; playlists?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ collaborative?: boolean; description?: string; external_urls?: { spotify?: string }; href?: string; id?: string; images?: ({ url: string; height: number | null; width: number | null })[]; name?: string; owner?: { external_urls?: { spotify?: string }; href?: string; id?: string; type?: "user"; uri?: string } & { display_name?: string | null }; public?: boolean; snapshot_id?: string; items?: { href?: string; total?: number }; tracks?: { href?: string; total?: number }; type?: string; uri?: string })[] }; shows?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; languages: (string)[]; media_type: string; name: string; publisher: string; type: "show"; uri: string; total_episodes: number } & { [key: string]: unknown })[] }; episodes?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ audio_preview_url: string | null; description: string; html_description: string; duration_ms: number; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; is_externally_hosted: boolean; is_playable: boolean; language?: string; languages: (string)[]; name: string; release_date: string; release_date_precision: "year" | "month" | "day"; resume_point?: { fully_played?: boolean; resume_position_ms?: number }; type: "episode"; uri: string; restrictions?: { reason?: string } } & { [key: string]: unknown })[] }; audiobooks?: { href: string; limit: number; next: string | null; offset: number; previous: string | null; total: number } & { items?: ({ authors: ({ name?: string })[]; available_markets: (string)[]; copyrights: ({ text?: string; type?: string })[]; description: string; html_description: string; edition?: string; explicit: boolean; external_urls: { spotify?: string }; href: string; id: string; images: ({ url: string; height: number | null; width: number | null })[]; languages: (string)[]; media_type: string; name: string; narrators: ({ name?: string })[]; publisher: string; type: "audiobook"; uri: string; total_chapters: number } & { [key: string]: unknown })[] } }>;
512
+ /**
513
+ * Seek To Position
514
+ * Tags: Player
515
+ * Access as: spotify.seekToPositionInCurrentlyPlayingTrack(input)
516
+ */
517
+ seekToPositionInCurrentlyPlayingTrack: (input: { position_ms: number; device_id?: string }) => Promise<{ error: { status: number; message: string } }>;
518
+ /**
519
+ * Set Repeat Mode
520
+ * Tags: Player
521
+ * Access as: spotify.setRepeatModeOnUsersPlayback(input)
522
+ */
523
+ setRepeatModeOnUsersPlayback: (input: { state: string; device_id?: string }) => Promise<{ error: { status: number; message: string } }>;
524
+ /**
525
+ * Set Playback Volume
526
+ * Tags: Player
527
+ * Access as: spotify.setVolumeForUsersPlayback(input)
528
+ */
529
+ setVolumeForUsersPlayback: (input: { volume_percent: number; device_id?: string }) => Promise<{ error: { status: number; message: string } }>;
530
+ /**
531
+ * Skip To Next
532
+ * Tags: Player
533
+ * Access as: spotify.skipUsersPlaybackToNextTrack(input)
534
+ */
535
+ skipUsersPlaybackToNextTrack: (input: { device_id?: string }) => Promise<{ error: { status: number; message: string } }>;
536
+ /**
537
+ * Skip To Previous
538
+ * Tags: Player
539
+ * Access as: spotify.skipUsersPlaybackToPreviousTrack(input)
540
+ */
541
+ skipUsersPlaybackToPreviousTrack: (input: { device_id?: string }) => Promise<{ error: { status: number; message: string } }>;
542
+ /**
543
+ * Start/Resume Playback
544
+ * Tags: Player
545
+ * Access as: spotify.startAUsersPlayback(input)
546
+ */
547
+ startAUsersPlayback: (input: { context_uri?: string; uris?: (string)[]; offset?: { [key: string]: unknown }; position_ms?: number; device_id?: string; [key: string]: unknown }) => Promise<{ error: { status: number; message: string } }>;
548
+ /**
549
+ * Toggle Playback Shuffle
550
+ * Tags: Player
551
+ * Access as: spotify.toggleShuffleForUsersPlayback(input)
552
+ */
553
+ toggleShuffleForUsersPlayback: (input: { state: boolean; device_id?: string }) => Promise<{ error: { status: number; message: string } }>;
554
+ /**
555
+ * Transfer Playback
556
+ * Tags: Player
557
+ * Access as: spotify.transferAUsersPlayback(input)
558
+ */
559
+ transferAUsersPlayback: (input: { device_ids: (string)[]; play?: boolean; [key: string]: unknown }) => Promise<{ error: { status: number; message: string } }>;
560
+ /**
561
+ * Unfollow Artists or Users
562
+ * Tags: Users, Artists, Library
563
+ * Access as: spotify.unfollowArtistsUsers(input, options)
564
+ */
565
+ unfollowArtistsUsers: (input: { ids?: (string)[]; type: "artist" | "user"; [key: string]: unknown }, options: { query: { ids: string } }) => Promise<{ error: { status: number; message: string } }>;
566
+ /**
567
+ * Unfollow Playlist
568
+ * Tags: Users, Playlists
569
+ * Access as: spotify.unfollowPlaylist(input)
570
+ */
571
+ unfollowPlaylist: (input: { playlist_id: string }) => Promise<{ error: { status: number; message: string } }>;
572
+ /**
573
+ * Add Custom Playlist Cover Image
574
+ * Tags: Playlists
575
+ * Access as: spotify.uploadCustomPlaylistCover(input)
576
+ */
577
+ uploadCustomPlaylistCover: (input: { body?: string; playlist_id: string }) => Promise<{ error: { status: number; message: string } }>;
578
+ };