Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
noook committed Jul 25, 2023
1 parent d52f704 commit 0202686
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ if (playbackState.item?.type === 'track') {

## 📦 Available APIs

- [🔒 Authentication](#---authentication)
- [💿 Albums](#---albums)
- [🎤 Artists](#---artists)
- [📗 Audiobooks](#---audiobooks)
Expand All @@ -54,7 +55,23 @@ if (playbackState.item?.type === 'track') {
- [🎼 Tracks](#---tracks)
- [👥 Users](#---users)

### 🔒 Authentication

These methods can be accessed directly through your `SpotifyClient` instance.

| Method | Description |
| -------| ----------- |
| `setAccessToken` | Sets the `access_token` for the current instance of `SpotifyClient` |
| `setRefreshToken` | Sets the `refresh_token` for the current instance of `SpotifyClient` |
| `generateOAuthUrl` | Generates an OAuth link with the provided scope |
| `getAccessToken` | Exchanges an authorization code for an `access_token` and a `refresh_token` |
| `refreshToken` | Obtain a new `access_token` from a refresh token |


### 💿 Albums

These methods can be accessed through the `albums` key of your `SpotifyClient` instance.

| Method | Description |
| -------| ----------- |
| [`getAlbum`](https://developer.spotify.com/documentation/web-api/reference/get-an-album) | Get Spotify catalog information for a single album. |
Expand All @@ -68,6 +85,8 @@ if (playbackState.item?.type === 'track') {

### 🎤 Artists

These methods can be accessed through the `artists` key of your `SpotifyClient` instance.

| Method | Description |
| -------| ----------- |
| [`getArtist`](https://developer.spotify.com/documentation/web-api/reference/get-an-artist) | Get Spotify catalog information for a single artist identified by their unique Spotify ID. |
Expand All @@ -78,6 +97,8 @@ if (playbackState.item?.type === 'track') {

### 📗 Audiobooks

These methods can be accessed through the `audiobooks` key of your `SpotifyClient` instance.

**Note:** Audiobooks are only available for the US, UK, Ireland, New Zealand and Australia markets.

| Method | Description |
Expand All @@ -92,13 +113,17 @@ if (playbackState.item?.type === 'track') {

### 🔖 Categories

These methods can be accessed through the `categories` key of your `SpotifyClient` instance.

| Method | Description |
| -------| ----------- |
| [`getCategories`](https://developer.spotify.com/documentation/web-api/reference/get-categories) | Get a list of categories used to tag items in Spotify (on, for example, the Spotify player’s “Browse” tab). |
| [`getCategory`](https://developer.spotify.com/documentation/web-api/reference/get-a-category) | Get a single category used to tag items in Spotify (on, for example, the Spotify player’s “Browse” tab). |

### 🕮 Chapters

These methods can be accessed through the `chapters` key of your `SpotifyClient` instance.

**Note:** Chapters are only available for the US, UK, Ireland, New Zealand and Australia markets.

| Method | Description |
Expand All @@ -108,6 +133,8 @@ if (playbackState.item?.type === 'track') {

### 🎙️ Episodes

These methods can be accessed through the `episodes` key of your `SpotifyClient` instance.

| Method | Description |
| -------| ----------- |
| [`getEpisode`](https://developer.spotify.com/documentation/web-api/reference/get-an-episode) | Get Spotify catalog information for a single episode identified by its unique Spotify ID. |
Expand All @@ -119,18 +146,24 @@ if (playbackState.item?.type === 'track') {

### 🪩 Genres

These methods can be accessed through the `genres` key of your `SpotifyClient` instance.

| Method | Description |
| -------| ----------- |
| [`getAvailableGenreSeeds`](https://developer.spotify.com/documentation/web-api/reference/get-recommendation-genres) | Retrieve a list of available genres seed parameter values for recommendations. |

### 🌍 Markets

These methods can be accessed through the `genres` key of your `SpotifyClient` instance.

| Method | Description |
| -------| ----------- |
| [`getMarkets`](https://developer.spotify.com/documentation/web-api/reference/get-available-markets) | Get the list of markets where Spotify is available. |

### ▶️ Player

These methods can be accessed through the `player` key of your `SpotifyClient` instance.

| Method | Description |
| -------| ----------- |
| [`getPlaybackState`](https://developer.spotify.com/documentation/web-api/reference/get-information-about-the-users-current-playback) | Get information about the user’s current playback state, including track or episode, progress, and active device. |
Expand All @@ -151,6 +184,8 @@ if (playbackState.item?.type === 'track') {

### 🎧 Playlists

These methods can be accessed through the `playlists` key of your `SpotifyClient` instance.

| Method | Description |
| -------| ----------- |
| [`getPlaylist`](https://developer.spotify.com/documentation/web-api/reference/get-playlist) | Get a playlist owned by a Spotify user. |
Expand All @@ -169,6 +204,8 @@ if (playbackState.item?.type === 'track') {

### 🔍 Search

These methods can be accessed through the `search` key of your `SpotifyClient` instance.

**Note:** Audiobooks are only available for the US, UK, Ireland, New Zealand and Australia markets.

| Method | Description |
Expand All @@ -177,6 +214,8 @@ if (playbackState.item?.type === 'track') {

### 🎙️ Shows

These methods can be accessed through the `shows` key of your `SpotifyClient` instance.

| Method | Description |
| -------| ----------- |
| [`getShow`](https://developer.spotify.com/documentation/web-api/reference/get-a-show) | Get Spotify catalog information for a single show identified by its unique Spotify ID. |
Expand All @@ -189,6 +228,8 @@ if (playbackState.item?.type === 'track') {

### 🎼 Tracks

These methods can be accessed through the `tracks` key of your `SpotifyClient` instance.

| Method | Description |
| -------| ----------- |
| [`getTrack`](https://developer.spotify.com/documentation/web-api/reference/get-track) | Get Spotify catalog information for a single track identified by its unique Spotify ID. |
Expand All @@ -204,6 +245,8 @@ if (playbackState.item?.type === 'track') {

### 👥 Users

These methods can be accessed through the `users` key of your `SpotifyClient` instance.

| Method | Description |
| -------| ----------- |
| [`getCurrentUserProfile`](https://developer.spotify.com/documentation/web-api/reference/get-current-users-profile) | Get detailed profile information about the current user (including the current user's username). |
Expand Down

0 comments on commit 0202686

Please sign in to comment.