Class: Spotted::Models::Browse::CategoryListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/spotted/models/browse/category_list_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

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

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

#initialize(limit: nil, locale: nil, offset: nil, request_options: {}) ⇒ Object

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

Parameters:

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

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

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

    The desired language, consisting of an [ISO 639-1](en.wikipedia.org/wiki/

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

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

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



# File 'lib/spotted/models/browse/category_list_params.rb', line 37

Instance Attribute Details

#limit ⇒ Integer?

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

Returns:

  • (Integer, nil) 


15
 
# File 'lib/spotted/models/browse/category_list_params.rb', line 15

optional :limit, Integer

#locale ⇒ String?

The desired language, consisting of an [ISO 639-1](en.wikipedia.org/wiki/ISO_639-1) language code and an [ISO 3166-1 alpha-2 country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2), joined by an underscore. For example: ‘es_MX`, meaning &quot;Spanish (Mexico)&quot;. Provide this parameter if you want the category strings returned in a particular language.<br/> _Note: if `locale` is not supplied, or if the specified language is not available, the category strings returned will be in the Spotify default language (American English)._

Returns:

  • (String, nil) 


28
 
# File 'lib/spotted/models/browse/category_list_params.rb', line 28

optional :locale, String

#offset ⇒ Integer?

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

Returns:

  • (Integer, nil) 


35
 
# File 'lib/spotted/models/browse/category_list_params.rb', line 35

optional :offset, Integer