Module: Spotted::Models::SearchQueryParams::Type

Extended by:
Internal::Type::Enum
Defined in:
lib/spotted/models/search_query_params.rb

Constant Summary collapse

ALBUM = 
:album
ARTIST = 
:artist
PLAYLIST = 
:playlist
TRACK = 
:track
SHOW = 
:show
EPISODE = 
:episode
AUDIOBOOK = 
:audiobook

Instance Method Summary collapse

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Instance Method Details

#initialize(q:, type:, include_external: nil, limit: nil, market: nil, offset: nil, request_options: {}) ⇒ Object

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

Parameters:

  • q (String) —

    Your search query.

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

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

  • include_external (Symbol, Spotted::Models::SearchQueryParams::IncludeExternal) (defaults to: nil) —

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

  • limit (Integer) (defaults to: nil) —

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

  • market (String) (defaults to: nil) —

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

  • offset (Integer) (defaults to: nil) —

    The index of the first result to return. Use

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


91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/spotted/models/search_query_params.rb', line 91

module Type
  extend Spotted::Internal::Type::Enum

  ALBUM = :album
  ARTIST = :artist
  PLAYLIST = :playlist
  TRACK = :track
  SHOW = :show
  EPISODE = :episode
  AUDIOBOOK = :audiobook

  # @!method self.values
  #   @return [Array<Symbol>]
end