Class: Spotted::Resources::Me::Episodes

Inherits:
Object
  • Object
show all
Defined in:
lib/spotted/resources/me/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:



132
133
134
 
# File 'lib/spotted/resources/me/episodes.rb', line 132

def initialize(client:)
  @client = client
end

Instance Method Details

#check(ids: , request_options: {}) ⇒ Array<Boolean>

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

Check if one or more episodes is already saved in the current Spotify user’s ‘Your Episodes’ library.<br/> 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](community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer)..

Parameters:

  • ids (String) —

    A comma-separated list of the [Spotify IDs](/documentation/web-api/concepts/spot

  • request_options (Spotted::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (Array<Boolean>)

See Also:



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/spotted/resources/me/episodes.rb', line 58

def check(params)
  parsed, options = Spotted::Me::EpisodeCheckParams.dump_request(params)
  @client.request(
    method: :get,
    path: "me/episodes/contains",
    query: parsed,
    model: Spotted::Internal::Type::ArrayOf[Spotted::Internal::Type::Boolean],
    options: options
  )
end

#list(limit: nil, market: nil, offset: nil, request_options: {}) ⇒ Spotted::Internal::CursorURLPage<Spotted::Models::Me::EpisodeListResponse>

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

Get a list of the episodes saved in the current Spotify user’s library.<br/> 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](community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer).

Parameters:

  • limit (Integer) —

    The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

  • market (String) —

    An [ISO 3166-1 alpha-2 country code](en.wikipedia.org/wiki/ISO_3166-1_al

  • offset (Integer) —

    The index of the first item to return. Default: 0 (the first item). Use with lim

  • request_options (Spotted::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/spotted/resources/me/episodes.rb', line 28

def list(params = {})
  parsed, options = Spotted::Me::EpisodeListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "me/episodes",
    query: parsed,
    page: Spotted::Internal::CursorURLPage,
    model: Spotted::Models::Me::EpisodeListResponse,
    options: options
  )
end

#remove(body_ids: nil, request_options: {}) ⇒ nil

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

Remove one or more episodes from the current user’s library.<br/> 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](community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer).

Parameters:

  • body_ids (Array<String>) —

    Body param: A JSON array of the [Spotify IDs](/documentation/web-api/concepts/sp

  • request_options (Spotted::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (nil)

See Also:



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/spotted/resources/me/episodes.rb', line 86

def remove(params = {})
  parsed, options = Spotted::Me::EpisodeRemoveParams.dump_request(params)
  query_params = [:query_ids]
  @client.request(
    method: :delete,
    path: "me/episodes",
    query: parsed.slice(*query_params).transform_keys(query_ids: "ids"),
    body: parsed.except(*query_params),
    model: NilClass,
    options: options
  )
end

#save(body_ids: , request_options: {}) ⇒ nil

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

Save one or more episodes to the current user’s library.<br/> 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](community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer).

Parameters:

  • body_ids (Array<String>) —

    Body param: A JSON array of the [Spotify IDs](/documentation/web-api/concepts/sp

  • request_options (Spotted::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (nil)

See Also:



116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/spotted/resources/me/episodes.rb', line 116

def save(params)
  parsed, options = Spotted::Me::EpisodeSaveParams.dump_request(params)
  query_params = [:query_ids]
  @client.request(
    method: :put,
    path: "me/episodes",
    query: parsed.slice(*query_params).transform_keys(query_ids: "ids"),
    body: parsed.except(*query_params),
    model: NilClass,
    options: options
  )
end