Exspotify.Shows (Exspotify v0.1.0)

View Source

Provides functions for interacting with the Shows endpoints of the Spotify Web API. See: https://developer.spotify.com/documentation/web-api/reference/shows

Note: The Shows API may not be fully supported by Spotify, may return 'resource not found', and does not have a dedicated scope. Use with caution.

Summary

Functions

Check if one or more shows are saved in the current user's library. Returns a list of booleans corresponding to the show IDs. https://developer.spotify.com/documentation/web-api/reference/check-users-saved-shows

Get Spotify catalog information for several shows based on their Spotify IDs. https://developer.spotify.com/documentation/web-api/reference/get-several-shows

Get Spotify catalog information for a single show by its unique Spotify ID. https://developer.spotify.com/documentation/web-api/reference/get-show

Get a list of the shows saved in the current Spotify user's library (paginated). Returns a Paging struct containing saved shows with added_at timestamps. https://developer.spotify.com/documentation/web-api/reference/get-users-saved-shows

Functions

check_users_saved_shows(show_ids, token)

@spec check_users_saved_shows([String.t()], String.t()) ::
  {:ok, [boolean()]} | {:error, Exspotify.Error.t()}

Check if one or more shows are saved in the current user's library. Returns a list of booleans corresponding to the show IDs. https://developer.spotify.com/documentation/web-api/reference/check-users-saved-shows

get_several_shows(show_ids, token)

@spec get_several_shows([String.t()], String.t()) ::
  {:ok, [Exspotify.Structs.Show.t()]} | {:error, Exspotify.Error.t()}

Get Spotify catalog information for several shows based on their Spotify IDs. https://developer.spotify.com/documentation/web-api/reference/get-several-shows

get_show(show_id, token)

@spec get_show(String.t(), String.t()) ::
  {:ok, Exspotify.Structs.Show.t()} | {:error, Exspotify.Error.t()}

Get Spotify catalog information for a single show by its unique Spotify ID. https://developer.spotify.com/documentation/web-api/reference/get-show

get_show_episodes(show_id, token, opts \\ [])

@spec get_show_episodes(String.t(), String.t(), keyword()) ::
  {:ok, Exspotify.Structs.Paging.t()} | {:error, Exspotify.Error.t()}

Get Spotify catalog information about a show's episodes (paginated). https://developer.spotify.com/documentation/web-api/reference/get-shows-episodes

get_users_saved_shows(token, opts \\ [])

@spec get_users_saved_shows(
  String.t(),
  keyword()
) :: {:ok, Exspotify.Structs.Paging.t()} | {:error, Exspotify.Error.t()}

Get a list of the shows saved in the current Spotify user's library (paginated). Returns a Paging struct containing saved shows with added_at timestamps. https://developer.spotify.com/documentation/web-api/reference/get-users-saved-shows

remove_users_saved_shows(show_ids, token)

@spec remove_users_saved_shows([String.t()], String.t()) ::
  {:ok, any()} | {:error, Exspotify.Error.t()}

Remove one or more shows from the current user's library. https://developer.spotify.com/documentation/web-api/reference/remove-shows-user

save_shows_for_current_user(show_ids, token)

@spec save_shows_for_current_user([String.t()], String.t()) ::
  {:ok, any()} | {:error, Exspotify.Error.t()}

Save one or more shows to the current user's library. https://developer.spotify.com/documentation/web-api/reference/save-shows-user