class AppleMusic::Album
Public Class Methods
find(id, **options)
click to toggle source
e.g. AppleMusic::Album.find(310730204)
developer.apple.com/documentation/applemusicapi/get_a_catalog_album
# File lib/apple_music/album.rb, line 9 def find(id, **options) storefront = Storefront.lookup(options.delete(:storefront)) response = AppleMusic.get("catalog/#{storefront}/albums/#{id}", options) Response.new(response.body).data.first end
get_collection_by_ids(ids, **options)
click to toggle source
e.g. AppleMusic::Album.get_collection_by_ids
([310730204, 19075891]) developer.apple.com/documentation/applemusicapi/get_multiple_catalog_albums
# File lib/apple_music/album.rb, line 29 def get_collection_by_ids(ids, **options) ids = ids.is_a?(Array) ? ids.join(',') : ids storefront = Storefront.lookup(options.delete(:storefront)) response = AppleMusic.get("catalog/#{storefront}/albums", options.merge(ids: ids)) Response.new(response.body).data end
get_collection_by_upc(upc, **options)
click to toggle source
e.g. AppleMusic::Album.get_collection_by_upc(8717837013241)
developer.apple.com/documentation/applemusicapi/get_multiple_catalog_albums_by_upc
# File lib/apple_music/album.rb, line 38 def get_collection_by_upc(upc, **options) upc = upc.is_a?(Array) ? upc.join(',') : upc storefront = Storefront.lookup(options.delete(:storefront)) response = AppleMusic.get("catalog/#{storefront}/albums", options.merge('filter[upc]': upc)) Response.new(response.body).data end
get_relationship(id, relationship_type, **options)
click to toggle source
e.g. AppleMusic::Album.get_relationship
(310730204, :artists) developer.apple.com/documentation/applemusicapi/get_a_catalog_album_s_relationship_directly_by_name
# File lib/apple_music/album.rb, line 47 def get_relationship(id, relationship_type, **options) storefront = Storefront.lookup(options.delete(:storefront)) response = AppleMusic.get("catalog/#{storefront}/albums/#{id}/#{relationship_type}", options) Response.new(response.body).data end
list(**options)
click to toggle source
e.g. AppleMusic::Album.list
(ids: [310730204, 19075891]) e.g. AppleMusic::Album.list
(upc: '8717837013241')
# File lib/apple_music/album.rb, line 17 def list(**options) if options[:ids] get_collection_by_ids(options.delete(:ids), **options) elsif options[:upc] get_collection_by_upc(options.delete(:upc), **options) else raise ParameterMissing, 'required parameter :ids or :upc is missing' end end
search(term, **options)
click to toggle source
# File lib/apple_music/album.rb, line 68 def search(term, **options) AppleMusic.search(**options.merge(term: term, types: :albums)).albums end