Class: Spotted::Resources::Episodes

Inherits:
Object
  • Object
show all
Defined in:
lib/spotted/resources/episodes.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Episodes

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Episodes.

Parameters:



64
65
66
 
# File 'lib/spotted/resources/episodes.rb', line 64

def initialize(client:)
  @client = client
end

Instance Method Details

#list(ids: , market: nil, request_options: {}) ⇒ Spotted::Models::EpisodeListResponse

Some parameter documentations has been truncated, see Models::EpisodeListParams for more details.

Get Spotify catalog information for several episodes based on their Spotify IDs.

Parameters:

Returns:

See Also:



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/spotted/resources/episodes.rb', line 50

def list(params)
  parsed, options = Spotted::EpisodeListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "episodes",
    query: parsed,
    model: Spotted::Models::EpisodeListResponse,
    options: options
  )
end

#retrieve(id, market: nil, request_options: {}) ⇒ Spotted::Models::EpisodeObject

Some parameter documentations has been truncated, see Models::EpisodeRetrieveParams for more details.

Get Spotify catalog information for a single episode identified by its unique Spotify ID.

Parameters:

Returns:

See Also:



23
24
25
26
27
28
29
30
31
32
 
# File 'lib/spotted/resources/episodes.rb', line 23

def retrieve(id, params = {})
  parsed, options = Spotted::EpisodeRetrieveParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["episodes/%1$s", id],
    query: parsed,
    model: Spotted::EpisodeObject,
    options: options
  )
end