Net-Async-Spotify/lib/Net/Async/Spotify/API/Generated/Library.pod
=encoding utf8
=for comment POD_DERIVED_INDEX_GENERATED
The following documentation is automatically generated. Please do not edit
this file, but rather the original, inline with Net::Async::Spotify::API::Generated::Library
at lib/Net/Async/Spotify/API/Generated/Library.pm
(on the system that originally ran this).
If you do edit this file, and don't want your changes to be removed, make
sure you change the first line.
=cut
=head1 NAME
Net::Async::Spotify::API::Generated::Library - Package representing Spotify Library API
=head1 DESCRIPTION
Autogenerated module.
Based on https://developer.spotify.com/documentation/web-api/reference/#reference-index
Check C<crawl-api-doc.pl> for more information.
=head1 METHODS
=head2 check_users_saved_albums
check_users_saved_albums - Check User's Saved Albums
Check if one or more albums is already saved in the current Spotify user’s ‘Your Music’ library.
with Request details being:
=head3 header
=over 4
=item Authorization
Type: string | Required: required
A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details. The user-library-read scope must have been authorized by the user.
=back
=head3 query_parameter
=over 4
=item ids
Type: string | Required: required
A comma-separated list of the Spotify IDs for the albums. Maximum: 50 IDs.
=back
and Response Objects being:
- error object
On success, the HTTP status code in the response header is 200 OK and the response body contains a JSON array of true or false values, in the same order in which the ids were specified.
On error, the header status code is an error code and the response body contains an error object.Try in our Web Console
=head2 check_users_saved_episodes
check_users_saved_episodes - Check User's Saved Episodes
Check if one or more episodes is already saved in the current Spotify user’s ‘Your Episodes’ library.
This API endpoint is in beta and could change without warning. Please share any feedback that you have, or issues that you discover, in our developer community forum..
with Request details being:
=head3 header
=over 4
=item Authorization
Type: string | Required: required
A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details. The user-library-read scope must have been authorized by the user.
=back
=head3 query_parameter
=over 4
=item ids
Type: string | Required: required
A comma-separated list of the Spotify IDs for the episodes. Maximum: 50 IDs.
=back
and Response Objects being:
- error object
On success, the HTTP status code in the response header is 200 OK and the response body contains a JSON array of true or false values, in the same order in which the ids were specified.
On error, the header status code is an error code and the response body contains an error object.Try in our Web Console
=head2 check_users_saved_shows
check_users_saved_shows - Check User's Saved Shows
Check if one or more shows is already saved in the current Spotify user’s library.
with Request details being:
=head3 header
=over 4
=item Authorization
Type: string | Required: required
A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details. The access token must have been isued on behalf of the user. The user-library-read scope must have been authorised by the user.
=back
=head3 query_parameter
=over 4
=item ids
Type: string | Required: required
A comma-separated list of the Spotify IDs for the shows. Maximum: 50 ids.
=back
and Response Objects being:
- error object
On success, the HTTP status code in the response header is 200 OK and the response body contains a JSON array of trueor false values, in the same order in which the ids were specified. On error, the header status code is an error code and the response body contains an error object.Try in our Web Console
=head2 check_users_saved_tracks
check_users_saved_tracks - Check User's Saved Tracks
Check if one or more tracks is already saved in the current Spotify user’s ‘Your Music’ library.
with Request details being:
=head3 header
=over 4
=item Authorization
Type: string | Required: required
A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details. The user-library-read scope must have been authorized by the user.
=back
=head3 query_parameter
=over 4
=item ids
Type: string | Required: required
A comma-separated list of the Spotify IDs for the tracks. Maximum: 50 IDs.
=back
and Response Objects being:
- error object
On success, the HTTP status code in the response header is 200 OK and the response body contains a JSON array of true or false values, in the same order in which the ids were specified.
On error, the header status code is an error code and the response body contains an error object.Try in our Web Console
=head2 get_users_saved_albums
get_users_saved_albums - Get User's Saved Albums
Get a list of the albums saved in the current Spotify user’s ‘Your Music’ library.
with Request details being:
=head3 header
=over 4
=item Authorization
Type: string | Required: required
A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details. The user-library-read scope must have been authorized by the user.
=back
=head3 query_parameter
=over 4
=item limit
Type: integer | Required: optional
The maximum number of objects to return. Default: 20. Minimum: 1. Maximum: 50.
=item market
Type: string | Required: optional
An ISO 3166-1 alpha-2 country code or the string from_token. Provide this parameter if you want to apply Track Relinking.
=item offset
Type: integer | Required: optional
The index of the first object to return. Default: 0 (i.e., the first object). Use with limit to get the next set of objects.
=back
and Response Objects being:
- album object
- error object
On success, the HTTP status code in the response header is 200 OK and the response body contains an array of saved album objects (wrapped in a paging object) in JSON format. Each album object is accompanied by a timestamp (added_at) to show when it was added. There is also an etag in the header that can be used in future conditional requests.On error, the header status code is an error code and the response body contains an error object.Try in our Web Console
=head2 get_users_saved_episodes
get_users_saved_episodes - Get User's Saved Episodes
Get a list of the episodes saved in the current Spotify user’s library.
This API endpoint is in beta and could change without warning. Please share any feedback that you have, or issues that you discover, in our developer community forum.
with Request details being:
=head3 header
=over 4
=item Authorization
Type: string | Required: required
A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details. The user-library-read scope must have been authorized by the user.
=back
=head3 query_parameter
=over 4
=item limit
Type: integer | Required: optional
The maximum number of objects to return. Default: 20. Minimum: 1. Maximum: 50.
=item market
Type: string | Required: optional
An ISO 3166-1 alpha-2 country code.
If a country code is specified, only episodes that are available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
Note: If neither market or user country are provided, the content is considered unavailable for the client.
Users can view the country that is associated with their account in the account settings.
=item offset
Type: integer | Required: optional
The index of the first object to return. Default: 0 (i.e., the first object). Use with limit to get the next set of objects.
=back
and Response Objects being:
- episode object
On success, the HTTP status code in the response header is 200 OK and the response body contains an array of saved episode objects (wrapped in a paging object) in JSON format. On error, the header status code is an error code and the response body contains an error object.Try in our Web Console
=head2 get_users_saved_shows
get_users_saved_shows - Get User's Saved Shows
Get a list of shows saved in the current Spotify user’s library. Optional parameters can be used to limit the number of shows returned.
with Request details being:
=head3 header
=over 4
=item Authorization
Type: string | Required: required
A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details. The access token must have been isued on behalf of the user. The user-library-read scope must have been authorised by the user.
=back
=head3 query_parameter
=over 4
=item limit
Type: integer | Required: optional
The maximum number of shows to return. Default: 20. Minimum: 1. Maximum: 50
=item offset
Type: integer | Required: optional
The index of the first show to return. Default: 0 (the first object). Use with limit to get the next set of shows.
=back
and Response Objects being:
- show object
On success, the HTTP status code in the response header is 200 OK and the response body contains an array of saved show objects (wrapped in a paging object) in JSON format.
If the current user has no shows saved, the response will be an empty array. If a show is unavailable in the given market it is filtered out. The total field in the paging object represents the number of all items, filtered or not, and thus might be larger than the actual total number of observable items.
On error, the header status code is an error code and the response body contains an error object.Try in our Web Console
=head2 get_users_saved_tracks
get_users_saved_tracks - Get User's Saved Tracks
Get a list of the songs saved in the current Spotify user’s ‘Your Music’ library.
with Request details being:
=head3 header
=over 4
=item Authorization
Type: string | Required: required
A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details. The user-library-read scope must have been authorized by the user.
=back
=head3 query_parameter
=over 4
=item limit
Type: integer | Required: optional
The maximum number of objects to return. Default: 20. Minimum: 1. Maximum: 50.
=item market
Type: string | Required: optional
An ISO 3166-1 alpha-2 country code or the string from_token. Provide this parameter if you want to apply Track Relinking.
=item offset
Type: integer | Required: optional
The index of the first object to return. Default: 0 (i.e., the first object). Use with limit to get the next set of objects.
=back
and Response Objects being:
- track object
On success, the HTTP status code in the response header is 200 OK and the response body contains an array of saved track objects (wrapped in a paging object) in JSON format. On error, the header status code is an error code and the response body contains an error object.Try in our Web Console
=head2 remove_albums_user
remove_albums_user - Remove Albums for Current User
Remove one or more albums from the current user’s ‘Your Music’ library.
with Request details being:
=head3 header
=over 4
=item Authorization
Type: string | Required: required
A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details.Modification of the current user’s “Your Music” collection requires authorization of the user-library-modify scope.
=item Content-Type
Type: string | Required: optional
Required if the IDs are passed in the request body, otherwise ignored. The content type of the request body: application/json
=back
=head3 json_body_parameter
=over 4
=item ids
Type: array[string] | Required: optional
A JSON array of the Spotify IDs. For example: ["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]A maximum of 50 items can be specified in one request. Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored.
=back
=head3 query_parameter
=over 4
=item ids
Type: string | Required: required
A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs.
=back
and Response Objects being:
- error object
On success, the HTTP status code in the response header is 200 Success. On error, the header status code is an error code and the response body contains an error object. Trying to remove an album when you do not have the user’s authorization returns error 403 Forbidden.Try in our Web Console
=head2 remove_episodes_user
remove_episodes_user - Remove User's Saved Episodes
Remove one or more episodes from the current user’s library.
This API endpoint is in beta and could change without warning. Please share any feedback that you have, or issues that you discover, in our developer community forum.
with Request details being:
=head3 header
=over 4
=item Authorization
Type: string | Required: required
A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details.Modification of the current user’s collection requires authorization of the user-library-modify scope.
=item Content-Type
Type: string | Required: optional
Required if the IDs are passed in the request body, otherwise ignored. The content type of the request body: application/json
=back
=head3 json_body_parameter
=over 4
=item ids
Type: array[string] | Required: optional
A JSON array of the Spotify IDs. A maximum of 50 items can be specified in one request. Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored.
=back
=head3 query_parameter
=over 4
=item ids
Type: string | Required: required
A comma-separated list of the Spotify IDs. Maximum: 50 IDs.
=back
and Response Objects being:
- error object
On success, the HTTP status code in the response header is 200 Success. On error, the header status code is an error code and the response body contains an error object. Trying to remove an episode when you do not have the user’s authorization returns error 403 Forbidden.Try in our Web Console
=head2 remove_shows_user
remove_shows_user - Remove User's Saved Shows
Delete one or more shows from current Spotify user’s library.
with Request details being:
=head3 header
=over 4
=item Authorization
Type: string | Required: required
A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details. The access token must have been issued on behalf of the user. The user-library-modify scope must have been authorized by the user.
=back
=head3 query_parameter
=over 4
=item ids
Type: string | Required: required
A comma-separated list of Spotify IDs for the shows to be deleted from the user’s library.
=item market
Type: string | Required: optional
An ISO 3166-1 alpha-2 country code.
If a country code is specified, only shows that are available in that market will be removed.
If a valid user access token is specified in the request header, the country associated with
the user account will take priority over this parameter.
Note: If neither market or user country are provided, the content is considered unavailable for the client.
Users can view the country that is associated with their account in the account settings.
=back
and Response Objects being:
- error object
On success, the HTTP status code in the response header is 200 OK.
On error, the header status code is an error code and the response body contains an error object. A 403 Forbidden while trying to add a show when you do not have the user’s authorisation.Try in our Web Console
=head2 remove_tracks_user
remove_tracks_user - Remove User's Saved Tracks
Remove one or more tracks from the current user’s ‘Your Music’ library.
with Request details being:
=head3 header
=over 4
=item Authorization
Type: string | Required: required
A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details.Modification of the current user’s “Your Music” collection requires authorization of the user-library-modify scope.
=item Content-Type
Type: string | Required: optional
Required if the IDs are passed in the request body, otherwise ignored. The content type of the request body: application/json
=back
=head3 json_body_parameter
=over 4
=item ids
Type: array[string] | Required: optional
A JSON array of the Spotify IDs. For example: ["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]A maximum of 50 items can be specified in one request. Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored.
=back
=head3 query_parameter
=over 4
=item ids
Type: string | Required: required
A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs.
=back
and Response Objects being:
- error object
On success, the HTTP status code in the response header is 200 Success. On error, the header status code is an error code and the response body contains an error object. Trying to remove an album when you do not have the user’s authorization returns error 403 Forbidden.Try in our Web Console
=head2 save_albums_user
save_albums_user - Save Albums for Current User
Save one or more albums to the current user’s ‘Your Music’ library.
with Request details being:
=head3 header
=over 4
=item Authorization
Type: string | Required: required
A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details.Modification of the current user’s “Your Music” collection requires authorization of the user-library-modify scope.
=item Content-Type
Type: string | Required: optional
Required if the IDs are passed in the request body, otherwise ignored. The content type of the request body: application/json
=back
=head3 json_body_parameter
=over 4
=item ids
Type: array[string] | Required: optional
A JSON array of the Spotify IDs. For example: ["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]A maximum of 50 items can be specified in one request. Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored.
=back
=head3 query_parameter
=over 4
=item ids
Type: string | Required: required
A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs.
=back
and Response Objects being:
- error object
On success, the HTTP status code in the response header is 201 Created. On error, the header status code is an error code and the response body contains an error object. Trying to add an album when you do not have the user’s authorization returns error 403 Forbidden.Try in our Web Console
=head2 save_episodes_user
save_episodes_user - Save Episodes for User
Save one or more episodes to the current user’s library.
This API endpoint is in beta and could change without warning. Please share any feedback that you have, or issues that you discover, in our developer community forum.
with Request details being:
=head3 header
=over 4
=item Authorization
Type: string | Required: required
A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details.Modification of the current user’s “Your Music” collection requires authorization of the user-library-modify scope.
=item Content-Type
Type: string | Required: optional
Required if the IDs are passed in the request body, otherwise ignored. The content type of the request body: application/json
=back
=head3 json_body_parameter
=over 4
=item ids
Type: array[string] | Required: optional
A JSON array of the Spotify IDs. A maximum of 50 items can be specified in one request. Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored.
=back
=head3 query_parameter
=over 4
=item ids
Type: string | Required: required
A comma-separated list of the Spotify IDs. Maximum: 50 IDs.
=back
and Response Objects being:
- error object
On success, the HTTP status code in the response header is 200 OK. On error, the header status code is an error code and the response body contains an error object. Trying to add an episode when you do not have the user’s authorization, returns error 403 Forbidden.Try in our Web Console
=head2 save_shows_user
save_shows_user - Save Shows for Current User
Save one or more shows to current Spotify user’s library.
with Request details being:
=head3 header
=over 4
=item Authorization
Type: string | Required: required
A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details. The access token must have been issued on behalf of the user. The user-library-modify scope must have been authorized by the user.
=back
=head3 query_parameter
=over 4
=item ids
Type: string | Required: required
A comma-separated list of the Spotify IDs. Maximum: 50 IDs.
=back
and Response Objects being:
- error object
On success, the HTTP status code in the response header is 200 OK. On error, the header status code is an error code and the response body contains an error object. A 403 Forbidden while trying to add a show when you do not have the user’s authorisation or when the user already has have over 10,000 items saved in library.Try in our Web Console
=head2 save_tracks_user
save_tracks_user - Save Tracks for User
Save one or more tracks to the current user’s ‘Your Music’ library.
with Request details being:
=head3 header
=over 4
=item Authorization
Type: string | Required: required
A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details.Modification of the current user’s “Your Music” collection requires authorization of the user-library-modify scope.
=item Content-Type
Type: string | Required: optional
Required if the IDs are passed in the request body, otherwise ignored. The content type of the request body: application/json
=back
=head3 json_body_parameter
=over 4
=item ids
Type: array[string] | Required: optional
A JSON array of the Spotify IDs. For example: ["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]A maximum of 50 items can be specified in one request. Note: if the ids parameter is present in the query string, any IDs listed here in the body will be ignored.
=back
=head3 query_parameter
=over 4
=item ids
Type: string | Required: required
A comma-separated list of the Spotify IDs. For example: ids=4iV5W9uYEdYUVa79Axb7Rh,1301WleyT98MSxVHPZCA6M. Maximum: 50 IDs.
=back
and Response Objects being:
- error object
On success, the HTTP status code in the response header is 200 OK. On error, the header status code is an error code and the response body contains an error object. Trying to add a track when you do not have the user’s authorization, or when you have over 10.000 tracks in Your Music, returns error 403 Forbidden.Try in our Web Console
=head1 INHERITED METHODS
=over 4
=item L<Net::Async::Spotify::API::Base>
L<call_api|Net::Async::Spotify::API::Base/call_api>, L<decode_response|Net::Async::Spotify::API::Base/decode_response>, L<new|Net::Async::Spotify::API::Base/new>, L<parse_response|Net::Async::Spotify::API::Base/parse_response>, L<spotify|Net::Async::Spotify::API::Base/spotify>
=back