Class: Spotted::Resources::Search

Inherits:

Object

• Object
• Spotted::Resources::Search

Defined in:

lib/spotted/resources/search.rb

Instance Method Summary

• #initialize(client:) ⇒ Search constructor private

  A new instance of Search.

• #retrieve(q: , type: , include_external: nil, limit: nil, market: nil, offset: nil, request_options: {}) ⇒ Spotted::Models::SearchRetrieveResponse

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

Constructor Details

#initialize(client:) ⇒ Search

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 Search.

Parameters:

• client (Spotted::Client)

# File 'lib/spotted/resources/search.rb', line 46

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve(q: , type: , include_external: nil, limit: nil, market: nil, offset: nil, request_options: {}) ⇒ Spotted::Models::SearchRetrieveResponse

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

Get Spotify catalog information about albums, artists, playlists, tracks, shows, episodes or audiobooks that match a keyword string. Audiobooks are only available within the US, UK, Canada, Ireland, New Zealand and Australia markets.

Parameters:

• q (String) —

  Your search query.

• type (Array<Symbol, Spotted::Models::SearchRetrieveParams::Type>) —

  A comma-separated list of item types to search across. Search results include hi

• include_external (Symbol, Spotted::Models::SearchRetrieveParams::IncludeExternal) —

  If ‘include_external=audio` is specified it signals that the client can play ext

• limit (Integer) —

  The maximum number of results to return in each item type.

• 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 result to return. Use

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

Returns:

• (Spotted::Models::SearchRetrieveResponse)

See Also:

• Models::SearchRetrieveParams

# File 'lib/spotted/resources/search.rb', line 32

def retrieve(params)
  parsed, options = Spotted::SearchRetrieveParams.dump_request(params)
  @client.request(
    method: :get,
    path: "search",
    query: parsed,
    model: Spotted::Models::SearchRetrieveResponse,
    options: options
  )
end